Skip to content
This repository was archived by the owner on Sep 5, 2023. It is now read-only.

docs: Add documentation for enums #45

Merged
merged 2 commits into from
Jan 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -975,7 +975,7 @@ def sample_delete_app_gateway():
# Done; return the response.
return response

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

def __exit__(self, type, value, traceback):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -287,12 +287,36 @@ class AppGateway(proto.Message):
class Type(proto.Enum):
r"""Enum containing list of all possible network connectivity
options supported by BeyondCorp AppGateway.

Values:
TYPE_UNSPECIFIED (0):
Default value. This value is unused.
TCP_PROXY (1):
TCP Proxy based BeyondCorp Connection. API
will default to this if unset.
"""
TYPE_UNSPECIFIED = 0
TCP_PROXY = 1

class State(proto.Enum):
r"""Represents the different states of an AppGateway."""
r"""Represents the different states of an AppGateway.

Values:
STATE_UNSPECIFIED (0):
Default value. This value is unused.
CREATING (1):
AppGateway is being created.
CREATED (2):
AppGateway has been created.
UPDATING (3):
AppGateway's configuration is being updated.
DELETING (4):
AppGateway is being deleted.
DOWN (5):
AppGateway is down and may be restored in the
future. This happens when CCFE sends
ProjectState = OFF.
"""
STATE_UNSPECIFIED = 0
CREATING = 1
CREATED = 2
Expand All @@ -303,6 +327,13 @@ class State(proto.Enum):
class HostType(proto.Enum):
r"""Enum containing list of all possible host types supported by
BeyondCorp Connection.

Values:
HOST_TYPE_UNSPECIFIED (0):
Default value. This value is unused.
GCP_REGIONAL_MIG (1):
AppGateway hosted in a GCP regional managed
instance group.
"""
HOST_TYPE_UNSPECIFIED = 0
GCP_REGIONAL_MIG = 1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-beyondcorp-appgateways",
"version": "0.4.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down