Skip to content

Commit 900a608

Browse files
docs: Add documentation for enums (#10822)
* 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: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFwcHMtc2NyaXB0LXR5cGUvLk93bEJvdC55YW1sIiwiaCI6IjAwODBmODMwZGVjMzdjMzM4NDE1NzA4MmJjZTI3OWUzNzA3OWVhNTgifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWNvbnRlbnR3YXJlaG91c2UvLk93bEJvdC55YW1sIiwiaCI6IjAwODBmODMwZGVjMzdjMzM4NDE1NzA4MmJjZTI3OWUzNzA3OWVhNTgifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFjYXRhbG9nLWxpbmVhZ2UvLk93bEJvdC55YW1sIiwiaCI6IjAwODBmODMwZGVjMzdjMzM4NDE1NzA4MmJjZTI3OWUzNzA3OWVhNTgifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRpc2NvdmVyeWVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiMDA4MGY4MzBkZWMzN2MzMzg0MTU3MDgyYmNlMjc5ZTM3MDc5ZWE1OCJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWVudGVycHJpc2Vrbm93bGVkZ2VncmFwaC8uT3dsQm90LnlhbWwiLCJoIjoiMDA4MGY4MzBkZWMzN2MzMzg0MTU3MDgyYmNlMjc5ZTM3MDc5ZWE1OCJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXZtd2FyZWVuZ2luZS8uT3dsQm90LnlhbWwiLCJoIjoiMDA4MGY4MzBkZWMzN2MzMzg0MTU3MDgyYmNlMjc5ZTM3MDc5ZWE1OCJ9 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtYWRkcmVzc3ZhbGlkYXRpb24vLk93bEJvdC55YW1sIiwiaCI6IjAwODBmODMwZGVjMzdjMzM4NDE1NzA4MmJjZTI3OWUzNzA3OWVhNTgifQ== Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtcm91dGluZy8uT3dsQm90LnlhbWwiLCJoIjoiMDA4MGY4MzBkZWMzN2MzMzg0MTU3MDgyYmNlMjc5ZTM3MDc5ZWE1OCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * revert * lint Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <[email protected]>
1 parent aed8240 commit 900a608

File tree

49 files changed

+1045
-57
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1045
-57
lines changed

packages/google-apps-script-type/google/apps/script/type/calendar/types/calendar_addon_manifest.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,28 @@ class CalendarAddOnManifest(proto.Message):
6262
class EventAccess(proto.Enum):
6363
r"""An enum defining the level of data access event triggers
6464
require.
65+
66+
Values:
67+
UNSPECIFIED (0):
68+
Default value when nothing is set for
69+
EventAccess.
70+
METADATA (1):
71+
METADATA gives event triggers the permission
72+
to access the metadata of events such as event
73+
id and calendar id.
74+
READ (3):
75+
READ gives event triggers access to all
76+
provided event fields including the metadata,
77+
attendees, and conference data.
78+
WRITE (4):
79+
WRITE gives event triggers access to the
80+
metadata of events and the ability to perform
81+
all actions, including adding attendees and
82+
setting conference data.
83+
READ_WRITE (5):
84+
READ_WRITE gives event triggers access to all provided event
85+
fields including the metadata, attendees, and conference
86+
data and the ability to perform all actions.
6587
"""
6688
UNSPECIFIED = 0
6789
METADATA = 1

packages/google-apps-script-type/google/apps/script/type/gmail/types/gmail_addon_manifest.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,20 @@ class ComposeTrigger(proto.Message):
161161
class DraftAccess(proto.Enum):
162162
r"""An enum defining the level of data access this compose
163163
trigger requires.
164+
165+
Values:
166+
UNSPECIFIED (0):
167+
Default value when nothing is set for
168+
DraftAccess.
169+
NONE (1):
170+
NONE means compose trigger won't be able to
171+
access any data of the draft when a compose
172+
addon is triggered.
173+
METADATA (2):
174+
METADATA gives compose trigger the permission
175+
to access the metadata of the draft when a
176+
compose addon is triggered. This includes the
177+
audience list (To/cc list) of a draft message.
164178
"""
165179
UNSPECIFIED = 0
166180
NONE = 1

packages/google-apps-script-type/google/apps/script/type/types/addon_widget_set.py

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,29 @@ class AddOnWidgetSet(proto.Message):
3434
"""
3535

3636
class WidgetType(proto.Enum):
37-
r"""The Widget type. DEFAULT is the basic widget set."""
37+
r"""The Widget type. DEFAULT is the basic widget set.
38+
39+
Values:
40+
WIDGET_TYPE_UNSPECIFIED (0):
41+
The default widget set.
42+
DATE_PICKER (1):
43+
The date picker.
44+
STYLED_BUTTONS (2):
45+
Styled buttons include filled buttons and
46+
disabled buttons.
47+
PERSISTENT_FORMS (3):
48+
Persistent forms allow persisting form values
49+
during actions.
50+
FIXED_FOOTER (4):
51+
Fixed footer in card.
52+
UPDATE_SUBJECT_AND_RECIPIENTS (5):
53+
Update the subject and recipients of a draft.
54+
GRID_WIDGET (6):
55+
The grid widget.
56+
ADDON_COMPOSE_UI_ACTION (7):
57+
A Gmail add-on action that applies to the
58+
addon compose UI.
59+
"""
3860
WIDGET_TYPE_UNSPECIFIED = 0
3961
DATE_PICKER = 1
4062
STYLED_BUTTONS = 2

packages/google-apps-script-type/google/apps/script/type/types/script_manifest.py

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,20 @@
3232

3333

3434
class HttpAuthorizationHeader(proto.Enum):
35-
r"""Authorization header sent in add-on HTTP requests"""
35+
r"""Authorization header sent in add-on HTTP requests
36+
37+
Values:
38+
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED (0):
39+
Default value, equivalent to ``SYSTEM_ID_TOKEN``
40+
SYSTEM_ID_TOKEN (1):
41+
Send an ID token for the project-specific
42+
Google Workspace Add-ons system service account
43+
(default)
44+
USER_ID_TOKEN (2):
45+
Send an ID token for the end user
46+
NONE (3):
47+
Do not send an Authentication header
48+
"""
3649
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED = 0
3750
SYSTEM_ID_TOKEN = 1
3851
USER_ID_TOKEN = 2

packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/services/document_link_service/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -904,7 +904,7 @@ def sample_delete_document_link():
904904
metadata=metadata,
905905
)
906906

907-
def __enter__(self):
907+
def __enter__(self) -> "DocumentLinkServiceClient":
908908
return self
909909

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

packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/services/document_schema_service/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1023,7 +1023,7 @@ def sample_list_document_schemas():
10231023
# Done; return the response.
10241024
return response
10251025

1026-
def __enter__(self):
1026+
def __enter__(self) -> "DocumentSchemaServiceClient":
10271027
return self
10281028

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

packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/services/document_service/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1274,7 +1274,7 @@ def sample_set_acl():
12741274
# Done; return the response.
12751275
return response
12761276

1277-
def __enter__(self):
1277+
def __enter__(self) -> "DocumentServiceClient":
12781278
return self
12791279

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

packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/services/rule_set_service/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1022,7 +1022,7 @@ def sample_list_rule_sets():
10221022
# Done; return the response.
10231023
return response
10241024

1025-
def __enter__(self):
1025+
def __enter__(self) -> "RuleSetServiceClient":
10261026
return self
10271027

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

packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/services/synonym_set_service/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1033,7 +1033,7 @@ def sample_list_synonym_sets():
10331033
# Done; return the response.
10341034
return response
10351035

1036-
def __enter__(self):
1036+
def __enter__(self) -> "SynonymSetServiceClient":
10371037
return self
10381038

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

packages/google-cloud-contentwarehouse/google/cloud/contentwarehouse_v1/types/common.py

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,23 @@
3434

3535

3636
class UpdateType(proto.Enum):
37-
r"""Update type of the requests."""
37+
r"""Update type of the requests.
38+
39+
Values:
40+
UPDATE_TYPE_UNSPECIFIED (0):
41+
Defaults to full replace behavior, ie. FULL_REPLACE.
42+
UPDATE_TYPE_REPLACE (1):
43+
Fully replace all the fields. Any field masks
44+
will be ignored.
45+
UPDATE_TYPE_MERGE (2):
46+
Merge the fields into the existing entities.
47+
UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES (3):
48+
Inserts the properties by names.
49+
UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES (4):
50+
Replace the properties by names.
51+
UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES (5):
52+
Delete the properties by names.
53+
"""
3854
UPDATE_TYPE_UNSPECIFIED = 0
3955
UPDATE_TYPE_REPLACE = 1
4056
UPDATE_TYPE_MERGE = 2
@@ -44,14 +60,39 @@ class UpdateType(proto.Enum):
4460

4561

4662
class DatabaseType(proto.Enum):
47-
r"""Type of database used by the customer"""
63+
r"""Type of database used by the customer
64+
65+
Values:
66+
DB_UNKNOWN (0):
67+
This value is required by protobuf best
68+
practices
69+
DB_INFRA_SPANNER (1):
70+
Internal Spanner
71+
DB_CLOUD_SQL_POSTGRES (2):
72+
Cloud Sql with a Postgres Sql instance
73+
"""
4874
DB_UNKNOWN = 0
4975
DB_INFRA_SPANNER = 1
5076
DB_CLOUD_SQL_POSTGRES = 2
5177

5278

5379
class AccessControlMode(proto.Enum):
54-
r"""Access Control Mode."""
80+
r"""Access Control Mode.
81+
82+
Values:
83+
ACL_MODE_UNKNOWN (0):
84+
This value is required by protobuf best
85+
practices
86+
ACL_MODE_UNIVERSAL_ACCESS (1):
87+
Universal Access: No document level access
88+
control.
89+
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID (2):
90+
Document level access control with customer
91+
own Identity Service.
92+
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI (3):
93+
Document level access control using Google
94+
Cloud Identity.
95+
"""
5596
ACL_MODE_UNKNOWN = 0
5697
ACL_MODE_UNIVERSAL_ACCESS = 1
5798
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID = 2

0 commit comments

Comments
 (0)