From 4434e2768f3883187c27b1313e7225080ad7afcd Mon Sep 17 00:00:00 2001 From: Jen Hamon Date: Wed, 29 Jan 2025 01:26:12 -0500 Subject: [PATCH] Add docstrings --- pinecone/enums/clouds.py | 8 ++++++++ pinecone/enums/deletion_protection.py | 9 +++++++++ 2 files changed, 17 insertions(+) diff --git a/pinecone/enums/clouds.py b/pinecone/enums/clouds.py index 6ee9f0fa..11829bd4 100644 --- a/pinecone/enums/clouds.py +++ b/pinecone/enums/clouds.py @@ -2,21 +2,29 @@ class CloudProvider(Enum): + """Cloud providers available for use with Pinecone serverless indexes""" + AWS = "aws" GCP = "gcp" AZURE = "azure" class AwsRegion(Enum): + """AWS (Amazon Web Services) regions available for use with Pinecone serverless indexes""" + US_EAST_1 = "us-east-1" US_WEST_2 = "us-west-2" EU_WEST_1 = "eu-west-1" class GcpRegion(Enum): + """GCP (Google Cloud Platform) regions available for use with Pinecone serverless indexes""" + US_CENTRAL1 = "us-central1" EUROPE_WEST4 = "europe-west4" class AzureRegion(Enum): + """Azure regions available for use with Pinecone serverless indexes""" + EAST_US = "eastus2" diff --git a/pinecone/enums/deletion_protection.py b/pinecone/enums/deletion_protection.py index dde4f261..8dd13d69 100644 --- a/pinecone/enums/deletion_protection.py +++ b/pinecone/enums/deletion_protection.py @@ -2,5 +2,14 @@ class DeletionProtection(Enum): + """The DeletionProtection setting of an index indicates whether the index + can be the index cannot be deleted using the delete_index() method. + + If disabled, the index can be deleted. If enabled, calling delete_index() + will raise an error. + + This setting can be changed using the configure_index() method. + """ + ENABLED = "enabled" DISABLED = "disabled"