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

Commit c546812

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Add documentation for enums (#42)
* 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: https://github.com/googleapis/googleapis-gen/commit/0080f830dec37c3384157082bce279e37079ea58 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>
1 parent 3001a35 commit c546812

File tree

3 files changed

+87
-6
lines changed

3 files changed

+87
-6
lines changed

‎google/cloud/dataform_v1beta1/services/dataform/client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3860,7 +3860,7 @@ def sample_query_workflow_invocation_actions():
38603860
# Done; return the response.
38613861
return response
38623862

3863-
def __enter__(self):
3863+
def __enter__(self) -> "DataformClient":
38643864
return self
38653865

38663866
def __exit__(self, type, value, traceback):

‎google/cloud/dataform_v1beta1/types/dataform.py‎

Lines changed: 85 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,22 @@ class GitRemoteSettings(proto.Message):
118118
"""
119119

120120
class TokenStatus(proto.Enum):
121-
r"""Indicates the status of a Git authentication token."""
121+
r"""Indicates the status of a Git authentication token.
122+
123+
Values:
124+
TOKEN_STATUS_UNSPECIFIED (0):
125+
Default value. This value is unused.
126+
NOT_FOUND (1):
127+
The token could not be found in Secret
128+
Manager (or the Dataform Service Account did not
129+
have permission to access it).
130+
INVALID (2):
131+
The token could not be used to authenticate
132+
against the Git remote.
133+
VALID (3):
134+
The token was used successfully to
135+
authenticate against the Git remote.
136+
"""
122137
TOKEN_STATUS_UNSPECIFIED = 0
123138
NOT_FOUND = 1
124139
INVALID = 2
@@ -624,7 +639,20 @@ class UncommittedFileChange(proto.Message):
624639
"""
625640

626641
class State(proto.Enum):
627-
r"""Indicates the status of an uncommitted file change."""
642+
r"""Indicates the status of an uncommitted file change.
643+
644+
Values:
645+
STATE_UNSPECIFIED (0):
646+
Default value. This value is unused.
647+
ADDED (1):
648+
The file has been newly added.
649+
DELETED (2):
650+
The file has been deleted.
651+
MODIFIED (3):
652+
The file has been modified.
653+
HAS_CONFLICTS (4):
654+
The file contains merge conflicts.
655+
"""
628656
STATE_UNSPECIFIED = 0
629657
ADDED = 1
630658
DELETED = 2
@@ -1571,7 +1599,20 @@ class Relation(proto.Message):
15711599
"""
15721600

15731601
class RelationType(proto.Enum):
1574-
r"""Indicates the type of this relation."""
1602+
r"""Indicates the type of this relation.
1603+
1604+
Values:
1605+
RELATION_TYPE_UNSPECIFIED (0):
1606+
Default value. This value is unused.
1607+
TABLE (1):
1608+
The relation is a table.
1609+
VIEW (2):
1610+
The relation is a view.
1611+
INCREMENTAL_TABLE (3):
1612+
The relation is an incrementalized table.
1613+
MATERIALIZED_VIEW (4):
1614+
The relation is a materialized view.
1615+
"""
15751616
RELATION_TYPE_UNSPECIFIED = 0
15761617
TABLE = 1
15771618
VIEW = 2
@@ -1947,7 +1988,26 @@ class WorkflowInvocation(proto.Message):
19471988
"""
19481989

19491990
class State(proto.Enum):
1950-
r"""Represents the current state of a workflow invocation."""
1991+
r"""Represents the current state of a workflow invocation.
1992+
1993+
Values:
1994+
STATE_UNSPECIFIED (0):
1995+
Default value. This value is unused.
1996+
RUNNING (1):
1997+
The workflow invocation is currently running.
1998+
SUCCEEDED (2):
1999+
The workflow invocation succeeded. A terminal
2000+
state.
2001+
CANCELLED (3):
2002+
The workflow invocation was cancelled. A
2003+
terminal state.
2004+
FAILED (4):
2005+
The workflow invocation failed. A terminal
2006+
state.
2007+
CANCELING (5):
2008+
The workflow invocation is being cancelled,
2009+
but some actions are still running.
2010+
"""
19512011
STATE_UNSPECIFIED = 0
19522012
RUNNING = 1
19532013
SUCCEEDED = 2
@@ -2194,6 +2254,27 @@ class WorkflowInvocationAction(proto.Message):
21942254
class State(proto.Enum):
21952255
r"""Represents the current state of an workflow invocation
21962256
action.
2257+
2258+
Values:
2259+
PENDING (0):
2260+
The action has not yet been considered for
2261+
invocation.
2262+
RUNNING (1):
2263+
The action is currently running.
2264+
SKIPPED (2):
2265+
Execution of the action was skipped because
2266+
upstream dependencies did not all complete
2267+
successfully. A terminal state.
2268+
DISABLED (3):
2269+
Execution of the action was disabled as per
2270+
the configuration of the corresponding
2271+
compilation result action. A terminal state.
2272+
SUCCEEDED (4):
2273+
The action succeeded. A terminal state.
2274+
CANCELLED (5):
2275+
The action was cancelled. A terminal state.
2276+
FAILED (6):
2277+
The action failed. A terminal state.
21972278
"""
21982279
PENDING = 0
21992280
RUNNING = 1

‎samples/generated_samples/snippet_metadata_google.cloud.dataform.v1beta1.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
],
99
"language": "PYTHON",
1010
"name": "google-cloud-dataform",
11-
"version": "0.4.0"
11+
"version": "0.1.0"
1212
},
1313
"snippets": [
1414
{

0 commit comments

Comments
 (0)