Skip to content

Commit

Permalink
Add docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
jhamon committed Jan 29, 2025
1 parent 72c627c commit 4434e27
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
8 changes: 8 additions & 0 deletions pinecone/enums/clouds.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
9 changes: 9 additions & 0 deletions pinecone/enums/deletion_protection.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"

0 comments on commit 4434e27

Please sign in to comment.