Skip to content

Commit

Permalink
docs: Add documentation for enums (#196)
Browse files Browse the repository at this point in the history
* docs: Add documentation for enums

fix: Add context manager return types

chore: Update gapic-generator-python to v1.8.1
PiperOrigin-RevId: 503210727

Source-Link: googleapis/googleapis@a391fd1

Source-Link: googleapis/googleapis-gen@0080f83
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMDA4MGY4MzBkZWMzN2MzMzg0MTU3MDgyYmNlMjc5ZTM3MDc5ZWE1OCJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Jan 20, 2023
1 parent 27471ef commit b5a973d
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2379,7 +2379,7 @@ def sample_delete_api_config():
# Done; return the response.
return response

def __enter__(self):
def __enter__(self) -> "ApiGatewayServiceClient":
return self

def __exit__(self, type, value, traceback):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,22 @@ class Api(proto.Message):
"""

class State(proto.Enum):
r"""All the possible API states."""
r"""All the possible API states.
Values:
STATE_UNSPECIFIED (0):
API does not have a state yet.
CREATING (1):
API is being created.
ACTIVE (2):
API is active.
FAILED (3):
API creation failed.
DELETING (4):
API is being deleted.
UPDATING (5):
API is being updated.
"""
STATE_UNSPECIFIED = 0
CREATING = 1
ACTIVE = 2
Expand Down Expand Up @@ -179,7 +194,27 @@ class ApiConfig(proto.Message):
"""

class State(proto.Enum):
r"""All the possible API Config states."""
r"""All the possible API Config states.
Values:
STATE_UNSPECIFIED (0):
API Config does not have a state yet.
CREATING (1):
API Config is being created and deployed to
the API Controller.
ACTIVE (2):
API Config is ready for use by Gateways.
FAILED (3):
API Config creation failed.
DELETING (4):
API Config is being deleted.
UPDATING (5):
API Config is being updated.
ACTIVATING (6):
API Config settings are being activated in
downstream systems. API Configs in this state
cannot be used by Gateways.
"""
STATE_UNSPECIFIED = 0
CREATING = 1
ACTIVE = 2
Expand Down Expand Up @@ -341,7 +376,22 @@ class Gateway(proto.Message):
"""

class State(proto.Enum):
r"""All the possible Gateway states."""
r"""All the possible Gateway states.
Values:
STATE_UNSPECIFIED (0):
Gateway does not have a state yet.
CREATING (1):
Gateway is being created.
ACTIVE (2):
Gateway is running and ready for requests.
FAILED (3):
Gateway creation failed.
DELETING (4):
Gateway is being deleted.
UPDATING (5):
Gateway is being updated.
"""
STATE_UNSPECIFIED = 0
CREATING = 1
ACTIVE = 2
Expand Down Expand Up @@ -786,6 +836,14 @@ class GetApiConfigRequest(proto.Message):
class ConfigView(proto.Enum):
r"""Enum to control which fields should be included in the
response.
Values:
CONFIG_VIEW_UNSPECIFIED (0):
BASIC (1):
Do not include configuration source files.
FULL (2):
Include configuration source files.
"""
CONFIG_VIEW_UNSPECIFIED = 0
BASIC = 1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-api-gateway",
"version": "1.6.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down

0 comments on commit b5a973d

Please sign in to comment.