Returns the organizations Resource.
+
+ permissions()
+
Returns the permissions Resource.
+ diff --git a/docs/dyn/accesscontextmanager_v1.permissions.html b/docs/dyn/accesscontextmanager_v1.permissions.html new file mode 100644 index 0000000000..9a5f20eaf0 --- /dev/null +++ b/docs/dyn/accesscontextmanager_v1.permissions.html @@ -0,0 +1,129 @@ + + + +
+ close()
Close httplib2 connections.
+
+ list(pageSize=None, pageToken=None, x__xgafv=None)
Lists all supported permissions in VPCSC Granular Controls.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
list(pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all supported permissions in VPCSC Granular Controls.
+
+Args:
+ pageSize: integer, Optional. This flag specifies the maximum number of services to return per page. Default is 100.
+ pageToken: string, Optional. Token to start on a later page. Default is the first page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A response to `ListSupportedPermissionsRequest`.
+ "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
+ "supportedPermissions": [ # List of VPC-SC supported permissions.
+ "A String",
+ ],
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
create(parent, body=None, securityMonitoringConditionId=None, x__xgafv=None)
Create a security monitoring condition.
+delete(name, riskAssessmentType=None, x__xgafv=None)
Delete a security monitoring condition.
+get(name, riskAssessmentType=None, x__xgafv=None)
Get a security monitoring condition.
- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
list(parent, filter=None, pageSize=None, pageToken=None, riskAssessmentType=None, x__xgafv=None)
List security monitoring conditions.
@@ -111,6 +111,7 @@delete(name, x__xgafv=None)
+ delete(name, riskAssessmentType=None, x__xgafv=None)
Delete a security monitoring condition.
Args:
name: string, Required. The name of the security monitoring condition to delete. Format: `organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}` (required)
+ riskAssessmentType: string, Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ Allowed values
+ RISK_ASSESSMENT_TYPE_UNSPECIFIED - Risk assessment type is not specified.
+ APIGEE - Risk assessment type is Apigee.
+ API_HUB - Risk assessment type is API Hub.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -179,11 +188,16 @@ Method Details
get(name, x__xgafv=None)
+ get(name, riskAssessmentType=None, x__xgafv=None)
Get a security monitoring condition.
Args:
name: string, Required. The name of the security monitoring condition to get. Format: `organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}` (required)
+ riskAssessmentType: string, Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ Allowed values
+ RISK_ASSESSMENT_TYPE_UNSPECIFIED - Risk assessment type is not specified.
+ APIGEE - Risk assessment type is Apigee.
+ API_HUB - Risk assessment type is API Hub.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -193,6 +207,7 @@ Method Details
An object of the form:
{ # Security monitoring condition for risk assessment version 2.
+ "apiHubGateway": "A String", # Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"createTime": "A String", # Output only. The time of the security monitoring condition creation.
"include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
"resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
@@ -206,7 +221,8 @@ Method Details
},
"name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
"profile": "A String", # Required. ID of security profile of the security monitoring condition.
- "scope": "A String", # Optional. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
+ "riskAssessmentType": "A String", # Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ "scope": "A String", # Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.
"totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
"totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
"updateTime": "A String", # Output only. The time of the security monitoring condition update.
@@ -214,14 +230,19 @@ Method Details
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ list(parent, filter=None, pageSize=None, pageToken=None, riskAssessmentType=None, x__xgafv=None)
List security monitoring conditions.
Args:
parent: string, Required. For a specific organization, list all the security monitoring conditions. Format: `organizations/{org}` (required)
- filter: string, Optional. Filter for the monitoring conditions. For example: `profile=profile1 AND scope=env1`
+ filter: string, Optional. Filter for the monitoring conditions. When RiskAssessmentType is APIGEE, monitoring conditions can be filtered by profile and scope. For example: `profile=profile1 AND scope=env1` When RiskAssessmentType is API_HUB, monitoring conditions can be filtered by profile and api_hub_gateway. For example: `profile=profile1 AND api_hub_gateway=gateway1`
pageSize: integer, Optional. The maximum number of monitoring conditions to return.
pageToken: string, Optional. A page token, received from a previous `ListSecurityMonitoringConditions` call. Provide this to retrieve the subsequent page.
+ riskAssessmentType: string, Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ Allowed values
+ RISK_ASSESSMENT_TYPE_UNSPECIFIED - Risk assessment type is not specified.
+ APIGEE - Risk assessment type is Apigee.
+ API_HUB - Risk assessment type is API Hub.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -234,6 +255,7 @@ Method Details
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"securityMonitoringConditions": [ # List of security monitoring conditions in the organization.
{ # Security monitoring condition for risk assessment version 2.
+ "apiHubGateway": "A String", # Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"createTime": "A String", # Output only. The time of the security monitoring condition creation.
"include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
"resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
@@ -247,7 +269,8 @@ Method Details
},
"name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
"profile": "A String", # Required. ID of security profile of the security monitoring condition.
- "scope": "A String", # Optional. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
+ "riskAssessmentType": "A String", # Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ "scope": "A String", # Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.
"totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
"totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
"updateTime": "A String", # Output only. The time of the security monitoring condition update.
@@ -280,6 +303,7 @@ Method Details
The object takes the form of:
{ # Security monitoring condition for risk assessment version 2.
+ "apiHubGateway": "A String", # Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"createTime": "A String", # Output only. The time of the security monitoring condition creation.
"include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
"resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
@@ -293,7 +317,8 @@ Method Details
},
"name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
"profile": "A String", # Required. ID of security profile of the security monitoring condition.
- "scope": "A String", # Optional. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
+ "riskAssessmentType": "A String", # Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ "scope": "A String", # Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.
"totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
"totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
"updateTime": "A String", # Output only. The time of the security monitoring condition update.
@@ -309,6 +334,7 @@ Method Details
An object of the form:
{ # Security monitoring condition for risk assessment version 2.
+ "apiHubGateway": "A String", # Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
"createTime": "A String", # Output only. The time of the security monitoring condition creation.
"include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
"resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
@@ -322,7 +348,8 @@ Method Details
},
"name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
"profile": "A String", # Required. ID of security profile of the security monitoring condition.
- "scope": "A String", # Optional. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
+ "riskAssessmentType": "A String", # Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
+ "scope": "A String", # Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.
"totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
"totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
"updateTime": "A String", # Output only. The time of the security monitoring condition update.
diff --git a/docs/dyn/appengine_v1beta.apps.services.versions.html b/docs/dyn/appengine_v1beta.apps.services.versions.html
index e45c4b630b..79036421cf 100644
--- a/docs/dyn/appengine_v1beta.apps.services.versions.html
+++ b/docs/dyn/appengine_v1beta.apps.services.versions.html
@@ -354,18 +354,6 @@ Method Details
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
- "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps.
- "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it.
- "networkTags": [ # The network tags to apply to the instance.
- { # Network tag message.
- "value": "A String", # value for the tag name
- },
- ],
- "subnetworkKey": { # Subnetwork key message. # The subnetwork key.
- "hostProjectId": "A String", # Project id (name not number) of the project that hosts the network
- "subnet": "A String", # Short name of the subnetwork. e.g. SUBNET instead of projects/{PROJECT_NAME}/regions/{REGION}/subnetworks/{SUBNET}
- },
- },
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
@@ -700,18 +688,6 @@ Method Details
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
- "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps.
- "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it.
- "networkTags": [ # The network tags to apply to the instance.
- { # Network tag message.
- "value": "A String", # value for the tag name
- },
- ],
- "subnetworkKey": { # Subnetwork key message. # The subnetwork key.
- "hostProjectId": "A String", # Project id (name not number) of the project that hosts the network
- "subnet": "A String", # Short name of the subnetwork. e.g. SUBNET instead of projects/{PROJECT_NAME}/regions/{REGION}/subnetworks/{SUBNET}
- },
- },
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
@@ -980,18 +956,6 @@ Method Details
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
- "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps.
- "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it.
- "networkTags": [ # The network tags to apply to the instance.
- { # Network tag message.
- "value": "A String", # value for the tag name
- },
- ],
- "subnetworkKey": { # Subnetwork key message. # The subnetwork key.
- "hostProjectId": "A String", # Project id (name not number) of the project that hosts the network
- "subnet": "A String", # Short name of the subnetwork. e.g. SUBNET instead of projects/{PROJECT_NAME}/regions/{REGION}/subnetworks/{SUBNET}
- },
- },
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
@@ -1263,18 +1227,6 @@ Method Details
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
- "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps.
- "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it.
- "networkTags": [ # The network tags to apply to the instance.
- { # Network tag message.
- "value": "A String", # value for the tag name
- },
- ],
- "subnetworkKey": { # Subnetwork key message. # The subnetwork key.
- "hostProjectId": "A String", # Project id (name not number) of the project that hosts the network
- "subnet": "A String", # Short name of the subnetwork. e.g. SUBNET instead of projects/{PROJECT_NAME}/regions/{REGION}/subnetworks/{SUBNET}
- },
- },
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
diff --git a/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.html b/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.html
index 987234bb74..7b9f692fe1 100644
--- a/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.html
+++ b/docs/dyn/appengine_v1beta.projects.locations.applications.services.versions.html
@@ -384,18 +384,6 @@ Method Details
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
- "vpcEgress": { # Deprecated: Use VpcAccess instead. Vpc Egress configuration. # Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps.
- "egressSetting": "A String", # The egress setting for the subnetwork, controlling what traffic is diverted through it.
- "networkTags": [ # The network tags to apply to the instance.
- { # Network tag message.
- "value": "A String", # value for the tag name
- },
- ],
- "subnetworkKey": { # Subnetwork key message. # The subnetwork key.
- "hostProjectId": "A String", # Project id (name not number) of the project that hosts the network
- "subnet": "A String", # Short name of the subnetwork. e.g. SUBNET instead of projects/{PROJECT_NAME}/regions/{REGION}/subnetworks/{SUBNET}
- },
- },
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
diff --git a/docs/dyn/apphub_v1.projects.locations.html b/docs/dyn/apphub_v1.projects.locations.html
index de327e9c84..5a51437375 100644
--- a/docs/dyn/apphub_v1.projects.locations.html
+++ b/docs/dyn/apphub_v1.projects.locations.html
@@ -118,7 +118,7 @@ Instance Methods
Gets a Boundary.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -210,7 +210,7 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service.
+ Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/apphub_v1alpha.projects.locations.html b/docs/dyn/apphub_v1alpha.projects.locations.html
index 57b3b9beef..63ce8ef065 100644
--- a/docs/dyn/apphub_v1alpha.projects.locations.html
+++ b/docs/dyn/apphub_v1alpha.projects.locations.html
@@ -118,7 +118,7 @@ Instance Methods
Gets a Boundary.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -210,7 +210,7 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service.
+ Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/calendar_v3.events.html b/docs/dyn/calendar_v3.events.html
index 66215fbf45..8f1e38099a 100644
--- a/docs/dyn/calendar_v3.events.html
+++ b/docs/dyn/calendar_v3.events.html
@@ -201,7 +201,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
@@ -508,7 +508,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
@@ -810,7 +810,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
@@ -1116,7 +1116,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
@@ -1427,7 +1427,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
@@ -1765,7 +1765,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
@@ -2169,7 +2169,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
@@ -2508,7 +2508,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
@@ -2815,7 +2815,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
@@ -3127,7 +3127,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
@@ -3443,7 +3443,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
@@ -3750,7 +3750,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
@@ -4062,7 +4062,7 @@ Method Details
# - "self" - Calendar owner's own birthday. Cannot have a contact. The Calendar API only supports creating events with the type "birthday". The type cannot be changed after the event is created.
},
"colorId": "A String", # The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.
- "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.
+ "conferenceData": { # The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. Warning: Reusing Google Meet conference data across different events can cause access issues and expose meeting details to unintended users. To help ensure meeting privacy, always generate a unique conference for each event by using the createRequest field.
"conferenceId": "A String", # The ID of the conference.
# Can be used by developers to keep track of conferences, should not be displayed to users.
# The ID value is formed differently for each conference solution type:
diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
index 651b184cc8..2fb9907ca8 100644
--- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
+++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html
@@ -172,6 +172,7 @@ Method Details
"data": "A String", # Optional. The data to sign. It can't be supplied if AsymmetricSignRequest.digest is supplied.
"dataCrc32c": "A String", # Optional. An optional CRC32C checksum of the AsymmetricSignRequest.data. If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(AsymmetricSignRequest.data) is equal to AsymmetricSignRequest.data_crc32c, and if so, perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
"digest": { # A Digest holds a cryptographic message digest. # Optional. The digest of the data to sign. The digest must be produced with the same digest algorithm as specified by the key version's algorithm. This field may not be supplied if AsymmetricSignRequest.data is supplied.
+ "externalMu": "A String", # A message digest produced with SHAKE-256, to be used with ML-DSA external-μ algorithms only. See "message representative" note in section 6.2, algorithm 7 of the FIPS-204 standard: https://doi.org/10.6028/nist.fips.204
"sha256": "A String", # A message digest produced with the SHA-256 algorithm.
"sha384": "A String", # A message digest produced with the SHA-384 algorithm.
"sha512": "A String", # A message digest produced with the SHA-512 algorithm.
diff --git a/docs/dyn/cloudscheduler_v1.projects.locations.html b/docs/dyn/cloudscheduler_v1.projects.locations.html
index 2fca1eace6..f6368c086d 100644
--- a/docs/dyn/cloudscheduler_v1.projects.locations.html
+++ b/docs/dyn/cloudscheduler_v1.projects.locations.html
@@ -95,7 +95,7 @@ Instance Methods
Gets the Scheduler config in the project/region.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -157,7 +157,7 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service.
+ Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/cloudscheduler_v1beta1.projects.locations.html b/docs/dyn/cloudscheduler_v1beta1.projects.locations.html
index d645fadd62..301adee1c8 100644
--- a/docs/dyn/cloudscheduler_v1beta1.projects.locations.html
+++ b/docs/dyn/cloudscheduler_v1beta1.projects.locations.html
@@ -92,7 +92,7 @@ Instance Methods
Gets information about a location.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -131,7 +131,7 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service.
+ Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html
index e421082b93..6bd0b18e96 100644
--- a/docs/dyn/compute_alpha.disks.html
+++ b/docs/dyn/compute_alpha.disks.html
@@ -822,7 +822,7 @@ Method Details
"options": "A String", # Internal use only.
"params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -1173,14 +1173,6 @@ Method Details
"type": "A String", # URL of the disk type resource describing which disk type to use to create
# the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
# types.
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
"users": [ # Output only. [Output Only] Links to the users of the disk (attached instances)
# in form:projects/project/zones/zone/instances/instance
"A String",
@@ -2345,7 +2337,7 @@ Method Details
# be a dash.
"params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -2578,10 +2570,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
}
guestFlush: boolean, [Input Only] Whether to attempt an application consistent snapshot by
@@ -3435,7 +3423,7 @@ Method Details
"options": "A String", # Internal use only.
"params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -3786,14 +3774,6 @@ Method Details
"type": "A String", # URL of the disk type resource describing which disk type to use to create
# the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
# types.
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
"users": [ # Output only. [Output Only] Links to the users of the disk (attached instances)
# in form:projects/project/zones/zone/instances/instance
"A String",
@@ -4505,7 +4485,7 @@ Method Details
"options": "A String", # Internal use only.
"params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -4856,14 +4836,6 @@ Method Details
"type": "A String", # URL of the disk type resource describing which disk type to use to create
# the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
# types.
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
"users": [ # Output only. [Output Only] Links to the users of the disk (attached instances)
# in form:projects/project/zones/zone/instances/instance
"A String",
@@ -5511,7 +5483,7 @@ Method Details
"options": "A String", # Internal use only.
"params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -5862,14 +5834,6 @@ Method Details
"type": "A String", # URL of the disk type resource describing which disk type to use to create
# the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
# types.
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
"users": [ # Output only. [Output Only] Links to the users of the disk (attached instances)
# in form:projects/project/zones/zone/instances/instance
"A String",
@@ -8690,7 +8654,7 @@ Method Details
update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the specified disk with the data included in the request.
The update is performed only on selected fields included as part
-of update-mask. Only the following fields can be modified: user_license.
+of update-mask.
Args:
project: string, Project ID for this request. (required)
@@ -8948,7 +8912,7 @@ Method Details
"options": "A String", # Internal use only.
"params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -9299,14 +9263,6 @@ Method Details
"type": "A String", # URL of the disk type resource describing which disk type to use to create
# the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
# types.
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
"users": [ # Output only. [Output Only] Links to the users of the disk (attached instances)
# in form:projects/project/zones/zone/instances/instance
"A String",
diff --git a/docs/dyn/compute_alpha.globalVmExtensionPolicies.html b/docs/dyn/compute_alpha.globalVmExtensionPolicies.html
index 030a0827c1..ac80c01a40 100644
--- a/docs/dyn/compute_alpha.globalVmExtensionPolicies.html
+++ b/docs/dyn/compute_alpha.globalVmExtensionPolicies.html
@@ -231,8 +231,8 @@ Method Details
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
# text format.
"description": "A String", # An optional description of this resource.
- "extensionPolicies": { # Required. A map of extension names (e.g., "cloudops") to their corresponding policy
- # configurations.
+ "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding
+ # policy configurations.
"a_key": { # Configuration for a specific VM extension.
"pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
# version is used.
@@ -278,7 +278,7 @@ Method Details
# The policy priority is an integer from 0 to 65535, inclusive. Lower
# integers indicate higher priorities. If you do not specify a priority when
# creating a rule, it is assigned a priority of 1000. If priorities are
- # equal, the policy with the more recent creation timestamp takes precedence.
+ # equal, the policy with the most recent creation timestamp takes precedence.
"selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
"selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
"state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.
diff --git a/docs/dyn/compute_alpha.imageFamilyViews.html b/docs/dyn/compute_alpha.imageFamilyViews.html
index fe649d4998..7721935a8a 100644
--- a/docs/dyn/compute_alpha.imageFamilyViews.html
+++ b/docs/dyn/compute_alpha.imageFamilyViews.html
@@ -323,7 +323,7 @@ Method Details
# be a dash.
"params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the image. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the image. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -637,14 +637,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
},
}
diff --git a/docs/dyn/compute_alpha.images.html b/docs/dyn/compute_alpha.images.html
index 1e8a9ceced..bdc197dbde 100644
--- a/docs/dyn/compute_alpha.images.html
+++ b/docs/dyn/compute_alpha.images.html
@@ -986,7 +986,7 @@ Method Details
# be a dash.
"params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the image. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the image. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -1300,14 +1300,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
}
@@ -1547,7 +1539,7 @@ Method Details
# be a dash.
"params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the image. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the image. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -1861,14 +1853,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
}
@@ -2468,7 +2452,7 @@ Method Details
# be a dash.
"params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the image. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the image. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -2782,14 +2766,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
}
forceCreate: boolean, Force image creation if true.
@@ -3404,7 +3380,7 @@ Method Details
# be a dash.
"params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the image. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the image. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -3718,14 +3694,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
},
],
"kind": "compute#imageList", # Output only. Type of resource.
@@ -4007,7 +3975,7 @@ Method Details
# be a dash.
"params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the image. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the image. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -4321,14 +4289,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
}
requestId: string, An optional request ID to identify requests. Specify a unique request ID so
diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html
index 35f7fd4311..93fb5212b3 100644
--- a/docs/dyn/compute_alpha.instanceGroupManagers.html
+++ b/docs/dyn/compute_alpha.instanceGroupManagers.html
@@ -1034,7 +1034,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -1284,11 +1284,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -1538,7 +1533,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -1788,11 +1783,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -1895,7 +1885,7 @@ Method Details
],
"params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are
# key-value pairs. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
# format such as `{org_id|project_id}/{tag_key_short_name}` and
@@ -4921,7 +4911,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -5171,11 +5161,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -5425,7 +5410,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -5675,11 +5660,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -5782,7 +5762,7 @@ Method Details
],
"params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are
# key-value pairs. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
# format such as `{org_id|project_id}/{tag_key_short_name}` and
@@ -6923,7 +6903,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -7173,11 +7153,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -7427,7 +7402,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -7677,11 +7652,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -7784,7 +7754,7 @@ Method Details
],
"params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are
# key-value pairs. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
# format such as `{org_id|project_id}/{tag_key_short_name}` and
@@ -9157,7 +9127,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -9407,11 +9377,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -9661,7 +9626,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -9911,11 +9876,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -10018,7 +9978,7 @@ Method Details
],
"params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are
# key-value pairs. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
# format such as `{org_id|project_id}/{tag_key_short_name}` and
@@ -11185,7 +11145,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -11435,11 +11395,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineType": "A String", # The machine type to be used for this instance.
@@ -11900,7 +11855,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -12150,11 +12105,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineType": "A String", # Output only. The machine type to be used for this instance.
@@ -12877,7 +12827,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -13127,11 +13077,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -13381,7 +13326,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -13631,11 +13576,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -13738,7 +13678,7 @@ Method Details
],
"params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are
# key-value pairs. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
# format such as `{org_id|project_id}/{tag_key_short_name}` and
@@ -18701,7 +18641,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -18951,11 +18891,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -19205,7 +19140,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -19455,11 +19390,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -19562,7 +19492,7 @@ Method Details
],
"params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are
# key-value pairs. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
# format such as `{org_id|project_id}/{tag_key_short_name}` and
diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html
index 21b07b1c5c..aeb0fe6325 100644
--- a/docs/dyn/compute_alpha.instanceTemplates.html
+++ b/docs/dyn/compute_alpha.instanceTemplates.html
@@ -531,7 +531,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -781,11 +781,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Display Device properties to enable support
@@ -1097,7 +1092,7 @@ Method Details
"A String",
],
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
@@ -2074,7 +2069,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -2324,11 +2319,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Display Device properties to enable support
@@ -2640,7 +2630,7 @@ Method Details
"A String",
],
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
@@ -3602,7 +3592,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -3852,11 +3842,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Display Device properties to enable support
@@ -4168,7 +4153,7 @@ Method Details
"A String",
],
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
@@ -5140,7 +5125,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -5390,11 +5375,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Display Device properties to enable support
@@ -5706,7 +5686,7 @@ Method Details
"A String",
],
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html
index 421fd8ee4d..0d940aef1f 100644
--- a/docs/dyn/compute_alpha.instances.html
+++ b/docs/dyn/compute_alpha.instances.html
@@ -1819,7 +1819,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -2069,11 +2069,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Enables display device for the instance.
@@ -2485,7 +2480,7 @@ Method Details
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -3334,7 +3329,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -3584,11 +3579,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
}
forceAttach: boolean, Whether to force attach the regional disk even if it's currently attached
@@ -4145,7 +4135,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -4395,11 +4385,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Alternative machine types to use for instances that are created from
@@ -4692,7 +4677,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -4942,11 +4927,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Display Device properties to enable support
@@ -5258,7 +5238,7 @@ Method Details
"A String",
],
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
@@ -5489,6 +5469,13 @@ Method Details
"locations": { # Location configurations mapped by location name.
# Currently only zone names are supported and must be represented as valid
# internal URLs, such as zones/us-central1-a.
+ # The bulkInsert operation doesn't create instances in an AI zone, even if
+ # an AI zone is available in the specified region. For example, if you set a
+ # DENY preference for us-central1-a, Compute Engine will consider
+ # us-central1-b and us-central1-c for instance creation, but not
+ # us-central1-ai1a. Also, you can't use the locations[] configuration to
+ # allow instance creation in an AI zone. To include an AI zone in bulkInsert
+ # operations, use the locationPolicy.zones[] field.
"a_key": {
"constraints": { # Per-zone constraints on location policy for this zone. # Constraints that the caller requires on the result distribution
# in this zone.
@@ -5504,11 +5491,13 @@ Method Details
},
},
"targetShape": "A String", # Strategy for distributing VMs across zones in a region.
- "zones": [ # List with zones where bulk will create instances.
+ "zones": [ # The bulkInsert operation applies any preferences set in the locations
+ # field to the specific zones listed in the zones field if the same zones
+ # are specified in both fields.
{
- "zone": "A String", # The URL of thezone.
+ "zone": "A String", # The URL of the zone.
# The zone must exist in the region where the request is called.
- # Zones must be represented as valid internal URLs,
+ # Zones must be represented as valid partial URLs,
# such as zones/us-central1-a.
},
],
@@ -7333,7 +7322,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -7583,11 +7572,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Enables display device for the instance.
@@ -7999,7 +7983,7 @@ Method Details
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -10223,11 +10207,10 @@ Method Details
"enforcementState": "A String", # The enforcement state of the extension.
# If the extension is not enforced yet, then the health status will not be
# specified.
+ "healthMsg": "A String", # The health status message of the extension.
"healthStatus": "A String", # The health status of the extension.
"name": "A String", # The name of the extension.
"policyId": "A String", # The id of the policy that is enforced on the extension.
- "unhealthyMsg": "A String", # The status message of the extension if the extension is in unhealthy
- # state.
"version": "A String", # The version of the extension.
}
@@ -10521,7 +10504,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -10771,11 +10754,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Enables display device for the instance.
@@ -11187,7 +11165,7 @@ Method Details
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -12400,7 +12378,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -12650,11 +12628,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Enables display device for the instance.
@@ -13066,7 +13039,7 @@ Method Details
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -13909,11 +13882,10 @@ Method Details
"enforcementState": "A String", # The enforcement state of the extension.
# If the extension is not enforced yet, then the health status will not be
# specified.
+ "healthMsg": "A String", # The health status message of the extension.
"healthStatus": "A String", # The health status of the extension.
"name": "A String", # The name of the extension.
"policyId": "A String", # The id of the policy that is enforced on the extension.
- "unhealthyMsg": "A String", # The status message of the extension if the extension is in unhealthy
- # state.
"version": "A String", # The version of the extension.
},
],
@@ -23215,7 +23187,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -23465,11 +23437,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Enables display device for the instance.
@@ -23881,7 +23848,7 @@ Method Details
# to 315,576,000,000 inclusive. Note: these bounds are computed from:
# 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html
index b0bfc72f83..fcfee24fc3 100644
--- a/docs/dyn/compute_alpha.machineImages.html
+++ b/docs/dyn/compute_alpha.machineImages.html
@@ -709,7 +709,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -959,11 +959,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Display Device properties to enable support
@@ -1275,7 +1270,7 @@ Method Details
"A String",
],
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
@@ -2951,7 +2946,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -3201,11 +3196,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Display Device properties to enable support
@@ -3517,7 +3507,7 @@ Method Details
"A String",
],
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
@@ -5199,7 +5189,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -5449,11 +5439,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Display Device properties to enable support
@@ -5765,7 +5750,7 @@ Method Details
"A String",
],
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
diff --git a/docs/dyn/compute_alpha.recoverableSnapshots.html b/docs/dyn/compute_alpha.recoverableSnapshots.html
index 9c2dab4449..8dc56d28d3 100644
--- a/docs/dyn/compute_alpha.recoverableSnapshots.html
+++ b/docs/dyn/compute_alpha.recoverableSnapshots.html
@@ -527,10 +527,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
},
"purgeTimestamp": "A String", # Output only. [Output Only] Purge timestamp of recoverable snapshot inRFC3339
# text format.
@@ -1243,10 +1239,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
},
"purgeTimestamp": "A String", # Output only. [Output Only] Purge timestamp of recoverable snapshot inRFC3339
# text format.
@@ -2032,10 +2024,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
},
"purgeTimestamp": "A String", # Output only. [Output Only] Purge timestamp of recoverable snapshot inRFC3339
# text format.
diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html
index b791ac85a4..6dbd740b71 100644
--- a/docs/dyn/compute_alpha.regionDisks.html
+++ b/docs/dyn/compute_alpha.regionDisks.html
@@ -898,7 +898,7 @@ Method Details
# be a dash.
"params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -1131,10 +1131,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
}
guestFlush: boolean, [Input Only] Specifies to create an application consistent snapshot by
@@ -1988,7 +1984,7 @@ Method Details
"options": "A String", # Internal use only.
"params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -2339,14 +2335,6 @@ Method Details
"type": "A String", # URL of the disk type resource describing which disk type to use to create
# the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
# types.
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
"users": [ # Output only. [Output Only] Links to the users of the disk (attached instances)
# in form:projects/project/zones/zone/instances/instance
"A String",
@@ -3055,7 +3043,7 @@ Method Details
"options": "A String", # Internal use only.
"params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -3406,14 +3394,6 @@ Method Details
"type": "A String", # URL of the disk type resource describing which disk type to use to create
# the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
# types.
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
"users": [ # Output only. [Output Only] Links to the users of the disk (attached instances)
# in form:projects/project/zones/zone/instances/instance
"A String",
@@ -4061,7 +4041,7 @@ Method Details
"options": "A String", # Internal use only.
"params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -4412,14 +4392,6 @@ Method Details
"type": "A String", # URL of the disk type resource describing which disk type to use to create
# the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
# types.
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
"users": [ # Output only. [Output Only] Links to the users of the disk (attached instances)
# in form:projects/project/zones/zone/instances/instance
"A String",
@@ -7237,8 +7209,7 @@ Method Details
update(project, region, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)
Update the specified disk with the data included in the request. Update is
-performed only on selected fields included as part of update-mask. Only the
-following fields can be modified: user_license.
+performed only on selected fields included as part of update-mask.
Args:
project: string, Project ID for this request. (required)
@@ -7496,7 +7467,7 @@ Method Details
"options": "A String", # Internal use only.
"params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -7847,14 +7818,6 @@ Method Details
"type": "A String", # URL of the disk type resource describing which disk type to use to create
# the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
# types.
- "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user
- # provided licenses can be modified after the disk is created. This includes
- # a list of URLs to the license resource. For example, to provide a debian
- # license:
- #
- # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
- "A String",
- ],
"users": [ # Output only. [Output Only] Links to the users of the disk (attached instances)
# in form:projects/project/zones/zone/instances/instance
"A String",
diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
index b252820d81..044a19303c 100644
--- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
+++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
@@ -2922,7 +2922,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -3172,11 +3172,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -3426,7 +3421,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -3676,11 +3671,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -3783,7 +3773,7 @@ Method Details
],
"params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are
# key-value pairs. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
# format such as `{org_id|project_id}/{tag_key_short_name}` and
@@ -4786,7 +4776,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -5036,11 +5026,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -5290,7 +5275,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -5540,11 +5525,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -5647,7 +5627,7 @@ Method Details
],
"params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are
# key-value pairs. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
# format such as `{org_id|project_id}/{tag_key_short_name}` and
@@ -7019,7 +6999,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -7269,11 +7249,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -7523,7 +7498,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -7773,11 +7748,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -7880,7 +7850,7 @@ Method Details
],
"params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are
# key-value pairs. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
# format such as `{org_id|project_id}/{tag_key_short_name}` and
@@ -9042,7 +9012,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -9292,11 +9262,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineType": "A String", # The machine type to be used for this instance.
@@ -9757,7 +9722,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -10007,11 +9972,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineType": "A String", # Output only. The machine type to be used for this instance.
@@ -10731,7 +10691,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -10981,11 +10941,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -11235,7 +11190,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -11485,11 +11440,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -11592,7 +11542,7 @@ Method Details
],
"params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are
# key-value pairs. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
# format such as `{org_id|project_id}/{tag_key_short_name}` and
@@ -16521,7 +16471,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -16771,11 +16721,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -17025,7 +16970,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -17275,11 +17220,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
@@ -17382,7 +17322,7 @@ Method Details
],
"params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are
+ "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are
# key-value pairs. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
# format such as `{org_id|project_id}/{tag_key_short_name}` and
diff --git a/docs/dyn/compute_alpha.regionInstanceTemplates.html b/docs/dyn/compute_alpha.regionInstanceTemplates.html
index 00f58febb0..6659d635a2 100644
--- a/docs/dyn/compute_alpha.regionInstanceTemplates.html
+++ b/docs/dyn/compute_alpha.regionInstanceTemplates.html
@@ -721,7 +721,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -971,11 +971,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Display Device properties to enable support
@@ -1287,7 +1282,7 @@ Method Details
"A String",
],
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
@@ -1879,7 +1874,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -2129,11 +2124,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Display Device properties to enable support
@@ -2445,7 +2435,7 @@ Method Details
"A String",
],
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
@@ -3418,7 +3408,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -3668,11 +3658,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Display Device properties to enable support
@@ -3984,7 +3969,7 @@ Method Details
"A String",
],
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html
index 9f9efe2c5f..4f30e57285 100644
--- a/docs/dyn/compute_alpha.regionInstances.html
+++ b/docs/dyn/compute_alpha.regionInstances.html
@@ -345,7 +345,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -595,11 +595,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"machineTypes": [ # Alternative machine types to use for instances that are created from
@@ -892,7 +887,7 @@ Method Details
# as the instance zone.
"A String",
],
- "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
# have the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -1142,11 +1137,6 @@ Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk,
# and the URL for regional disk.
"type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
- "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of
- # URLs to the license resource. Unlike regular licenses, user provided
- # licenses can be modified after the disk is created.
- "A String",
- ],
},
],
"displayDevice": { # A set of Display Device options # Display Device properties to enable support
@@ -1458,7 +1448,7 @@ Method Details
"A String",
],
},
- "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values
# have the same definition as resource
# manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
# values are in the format `tagValues/456`. The field is ignored (both PUT &
@@ -1689,6 +1679,13 @@ Method Details
"locations": { # Location configurations mapped by location name.
# Currently only zone names are supported and must be represented as valid
# internal URLs, such as zones/us-central1-a.
+ # The bulkInsert operation doesn't create instances in an AI zone, even if
+ # an AI zone is available in the specified region. For example, if you set a
+ # DENY preference for us-central1-a, Compute Engine will consider
+ # us-central1-b and us-central1-c for instance creation, but not
+ # us-central1-ai1a. Also, you can't use the locations[] configuration to
+ # allow instance creation in an AI zone. To include an AI zone in bulkInsert
+ # operations, use the locationPolicy.zones[] field.
"a_key": {
"constraints": { # Per-zone constraints on location policy for this zone. # Constraints that the caller requires on the result distribution
# in this zone.
@@ -1704,11 +1701,13 @@ Method Details
},
},
"targetShape": "A String", # Strategy for distributing VMs across zones in a region.
- "zones": [ # List with zones where bulk will create instances.
+ "zones": [ # The bulkInsert operation applies any preferences set in the locations
+ # field to the specific zones listed in the zones field if the same zones
+ # are specified in both fields.
{
- "zone": "A String", # The URL of thezone.
+ "zone": "A String", # The URL of the zone.
# The zone must exist in the region where the request is called.
- # Zones must be represented as valid internal URLs,
+ # Zones must be represented as valid partial URLs,
# such as zones/us-central1-a.
},
],
diff --git a/docs/dyn/compute_alpha.regionRecoverableSnapshots.html b/docs/dyn/compute_alpha.regionRecoverableSnapshots.html
index b4a8d3fb0e..215e0c4ed1 100644
--- a/docs/dyn/compute_alpha.regionRecoverableSnapshots.html
+++ b/docs/dyn/compute_alpha.regionRecoverableSnapshots.html
@@ -723,10 +723,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
},
"purgeTimestamp": "A String", # Output only. [Output Only] Purge timestamp of recoverable snapshot inRFC3339
# text format.
@@ -1515,10 +1511,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
},
"purgeTimestamp": "A String", # Output only. [Output Only] Purge timestamp of recoverable snapshot inRFC3339
# text format.
diff --git a/docs/dyn/compute_alpha.regionSnapshots.html b/docs/dyn/compute_alpha.regionSnapshots.html
index e638d8ec37..b79a8a28c4 100644
--- a/docs/dyn/compute_alpha.regionSnapshots.html
+++ b/docs/dyn/compute_alpha.regionSnapshots.html
@@ -523,7 +523,7 @@ Method Details
# be a dash.
"params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -756,10 +756,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
}
@@ -1236,7 +1232,7 @@ Method Details
# be a dash.
"params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -1469,10 +1465,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
}
requestId: string, An optional request ID to identify requests. Specify a unique request ID so
@@ -1956,7 +1948,7 @@ Method Details
# be a dash.
"params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -2189,10 +2181,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
},
],
"kind": "compute#snapshotList", # Output only. Type of resource.
diff --git a/docs/dyn/compute_alpha.snapshots.html b/docs/dyn/compute_alpha.snapshots.html
index ad53be0a4f..79699a59f5 100644
--- a/docs/dyn/compute_alpha.snapshots.html
+++ b/docs/dyn/compute_alpha.snapshots.html
@@ -326,7 +326,7 @@ Method Details
# be a dash.
"params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -559,10 +559,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
},
],
"warning": { # [Output Only] Informational warning which replaces the list of snapshots
@@ -1059,7 +1055,7 @@ Method Details
# be a dash.
"params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -1292,10 +1288,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
}
update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part -of update-mask. Only the following fields can be modified: user_license. +of update-mask. Args: project: string, Project ID for this request. (required) @@ -8084,7 +8068,7 @@diff --git a/docs/dyn/compute_beta.images.html b/docs/dyn/compute_beta.images.html index 5d437f86e8..9c53b32783 100644 --- a/docs/dyn/compute_beta.images.html +++ b/docs/dyn/compute_beta.images.html @@ -960,7 +960,7 @@Method Details
"options": "A String", # Internal use only. "params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -8362,14 +8346,6 @@Method Details
"type": "A String", # URL of the disk type resource describing which disk type to use to create # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk # types. - "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user - # provided licenses can be modified after the disk is created. This includes - # a list of URLs to the license resource. For example, to provide a debian - # license: - # - # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch - "A String", - ], "users": [ # Output only. [Output Only] Links to the users of the disk (attached instances) # in form:projects/project/zones/zone/instances/instance "A String", diff --git a/docs/dyn/compute_beta.globalVmExtensionPolicies.html b/docs/dyn/compute_beta.globalVmExtensionPolicies.html index ece4c85f42..37fb413b2d 100644 --- a/docs/dyn/compute_beta.globalVmExtensionPolicies.html +++ b/docs/dyn/compute_beta.globalVmExtensionPolicies.html @@ -222,8 +222,8 @@Method Details
"creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 # text format. "description": "A String", # An optional description of this resource. - "extensionPolicies": { # Required. A map of extension names (e.g., "cloudops") to their corresponding policy - # configurations. + "extensionPolicies": { # Required. A map of extension names (for example, "ops-agent") to their corresponding + # policy configurations. "a_key": { # Configuration for a specific VM extension. "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest # version is used. @@ -269,7 +269,7 @@Method Details
# The policy priority is an integer from 0 to 65535, inclusive. Lower # integers indicate higher priorities. If you do not specify a priority when # creating a rule, it is assigned a priority of 1000. If priorities are - # equal, the policy with the more recent creation timestamp takes precedence. + # equal, the policy with the most recent creation timestamp takes precedence. "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id. "state": "A String", # Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING. diff --git a/docs/dyn/compute_beta.html b/docs/dyn/compute_beta.html index 843604ba71..3289f237e2 100644 --- a/docs/dyn/compute_beta.html +++ b/docs/dyn/compute_beta.html @@ -614,6 +614,11 @@Instance Methods
Returns the serviceAttachments Resource.
++
+snapshotGroups()+Returns the snapshotGroups Resource.
+ diff --git a/docs/dyn/compute_beta.imageFamilyViews.html b/docs/dyn/compute_beta.imageFamilyViews.html index da35af6342..ecb47eddfa 100644 --- a/docs/dyn/compute_beta.imageFamilyViews.html +++ b/docs/dyn/compute_beta.imageFamilyViews.html @@ -323,7 +323,7 @@Method Details
# be a dash. "params": { # Additional image params. # Input only. [Input Only] Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to be bound to the image. Tag keys and values have + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the image. Tag keys and values have # the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -636,14 +636,6 @@Method Details
# multi-regional). "A String", ], - "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user - # provided licenses can be modified after the disk is created. This includes - # a list of URLs to the license resource. For example, to provide a debian - # license: - # - # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch - "A String", - ], }, }
Close httplib2 connections.
+ +Updates the accelerator topologies configuration.
createInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)
Creates instances with per-instance configurations in this managed instance
@@ -960,7 +963,7 @@Close httplib2 connections.+
configureAcceleratorTopologies(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)
+ Updates the accelerator topologies configuration.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of thezone
+where the managed instance group is located.
+It should conform to RFC1035. (required)
+ instanceGroupManager: string, The name of the managed instance group.
+It should conform to RFC1035. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # InstanceGroupManagers.ConfigureAcceleratorTopologies
+ "acceleratorTopologyActions": { # Map of accelerator topologies that should have their state changed to
+ # the specified value. The key is the hashed topology locus id. It can be
+ # obtained from the GetAvailableAcceleratorTopologies rpc.
+ "a_key": "A String",
+ },
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `user@example.com` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}
+createInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)
Creates instances with per-instance configurations in this managed instance @@ -3770,7 +4062,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -4020,11 +4312,6 @@Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk, # and the URL for regional disk. "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of - # URLs to the license resource. Unlike regular licenses, user provided - # licenses can be modified after the disk is created. - "A String", - ], }, ], "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". @@ -4110,7 +4397,7 @@Method Details
], "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are + "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are # key-value pairs. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced # format such as `{org_id|project_id}/{tag_key_short_name}` and @@ -4587,8 +4874,113 @@Method Details
"a_key": { "acceleratorTopology": "A String", # Topology in the format of: "16x16", "4x4x4", etc. "acceleratorTopologyHealth": "A String", + "acceleratorTopologyState": { # Specifies the topology state + "currentState": "A String", + "error": { # Reason why the topology state change failed + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "errorTimestamp": "A String", # Timestamp when the last error happened + }, + "instancesHealth": "A String", + "parent": "A String", # Identified by the topology Id in the accelerator_topology_info map. Empty + # for the top-level topology }, }, + "multiMig": "A String", # URL to MMIG this MIG belongs to. }
update(project, region, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)
Update the specified disk with the data included in the request. Update is -performed only on selected fields included as part of update-mask. Only the -following fields can be modified: user_license. +performed only on selected fields included as part of update-mask. Args: project: string, Project ID for this request. (required) @@ -7027,7 +7018,7 @@Method Details
"options": "A String", # Internal use only. "params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -7305,14 +7296,6 @@Method Details
"type": "A String", # URL of the disk type resource describing which disk type to use to create # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk # types. - "userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user - # provided licenses can be modified after the disk is created. This includes - # a list of URLs to the license resource. For example, to provide a debian - # license: - # - # https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch - "A String", - ], "users": [ # Output only. [Output Only] Links to the users of the disk (attached instances) # in form:projects/project/zones/zone/instances/instance "A String", diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html index 511185e8c3..d64f02ba11 100644 --- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html @@ -2769,7 +2769,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -3019,11 +3019,6 @@Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk, # and the URL for regional disk. "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of - # URLs to the license resource. Unlike regular licenses, user provided - # licenses can be modified after the disk is created. - "A String", - ], }, ], "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". @@ -3109,7 +3104,7 @@Method Details
], "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are + "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are # key-value pairs. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced # format such as `{org_id|project_id}/{tag_key_short_name}` and @@ -3937,7 +3932,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -4187,11 +4182,6 @@Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk, # and the URL for regional disk. "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of - # URLs to the license resource. Unlike regular licenses, user provided - # licenses can be modified after the disk is created. - "A String", - ], }, ], "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". @@ -4277,7 +4267,7 @@Method Details
], "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are + "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are # key-value pairs. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced # format such as `{org_id|project_id}/{tag_key_short_name}` and @@ -5461,7 +5451,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -5711,11 +5701,6 @@Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk, # and the URL for regional disk. "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of - # URLs to the license resource. Unlike regular licenses, user provided - # licenses can be modified after the disk is created. - "A String", - ], }, ], "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". @@ -5801,7 +5786,7 @@Method Details
], "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are + "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are # key-value pairs. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced # format such as `{org_id|project_id}/{tag_key_short_name}` and @@ -7025,7 +7010,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -7275,11 +7260,6 @@Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk, # and the URL for regional disk. "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of - # URLs to the license resource. Unlike regular licenses, user provided - # licenses can be modified after the disk is created. - "A String", - ], }, ], "machineType": "A String", # Output only. The machine type to be used for this instance. @@ -7937,7 +7917,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -8187,11 +8167,6 @@Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk, # and the URL for regional disk. "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of - # URLs to the license resource. Unlike regular licenses, user provided - # licenses can be modified after the disk is created. - "A String", - ], }, ], "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". @@ -8277,7 +8252,7 @@Method Details
], "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are + "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are # key-value pairs. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced # format such as `{org_id|project_id}/{tag_key_short_name}` and @@ -12831,7 +12806,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -13081,11 +13056,6 @@Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk, # and the URL for regional disk. "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of - # URLs to the license resource. Unlike regular licenses, user provided - # licenses can be modified after the disk is created. - "A String", - ], }, ], "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16". @@ -13171,7 +13141,7 @@Method Details
], "params": { # Input only additional params for instance group manager creation. # Input only. Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to bind to the managed instance group. The tags are + "resourceManagerTags": { # Input only. Resource manager tags to bind to the managed instance group. The tags are # key-value pairs. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced # format such as `{org_id|project_id}/{tag_key_short_name}` and diff --git a/docs/dyn/compute_beta.regionInstanceTemplates.html b/docs/dyn/compute_beta.regionInstanceTemplates.html index 0ecee48fb2..c89284dcb2 100644 --- a/docs/dyn/compute_beta.regionInstanceTemplates.html +++ b/docs/dyn/compute_beta.regionInstanceTemplates.html @@ -696,7 +696,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -946,11 +946,6 @@Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk, # and the URL for regional disk. "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of - # URLs to the license resource. Unlike regular licenses, user provided - # licenses can be modified after the disk is created. - "A String", - ], }, ], "displayDevice": { # A set of Display Device options # Display Device properties to enable support @@ -1227,7 +1222,7 @@Method Details
"A String", ], }, - "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values # have the same definition as resource # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and # values are in the format `tagValues/456`. The field is ignored (both PUT & @@ -1760,7 +1755,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -2010,11 +2005,6 @@Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk, # and the URL for regional disk. "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of - # URLs to the license resource. Unlike regular licenses, user provided - # licenses can be modified after the disk is created. - "A String", - ], }, ], "displayDevice": { # A set of Display Device options # Display Device properties to enable support @@ -2291,7 +2281,7 @@Method Details
"A String", ], }, - "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values # have the same definition as resource # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and # values are in the format `tagValues/456`. The field is ignored (both PUT & @@ -3192,7 +3182,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -3442,11 +3432,6 @@Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk, # and the URL for regional disk. "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of - # URLs to the license resource. Unlike regular licenses, user provided - # licenses can be modified after the disk is created. - "A String", - ], }, ], "displayDevice": { # A set of Display Device options # Display Device properties to enable support @@ -3723,7 +3708,7 @@Method Details
"A String", ], }, - "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values # have the same definition as resource # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and # values are in the format `tagValues/456`. The field is ignored (both PUT & diff --git a/docs/dyn/compute_beta.regionInstances.html b/docs/dyn/compute_beta.regionInstances.html index 925758b1d0..91452d1945 100644 --- a/docs/dyn/compute_beta.regionInstances.html +++ b/docs/dyn/compute_beta.regionInstances.html @@ -339,7 +339,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -589,11 +589,6 @@Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk, # and the URL for regional disk. "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of - # URLs to the license resource. Unlike regular licenses, user provided - # licenses can be modified after the disk is created. - "A String", - ], }, ], "machineTypes": [ # Alternative machine types to use for instances that are created from @@ -874,7 +869,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -1124,11 +1119,6 @@Method Details
# Note that for InstanceTemplate, specify the disk name for zonal disk, # and the URL for regional disk. "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT. - "userLicenses": [ # Output only. [Output Only] A list of user provided licenses. It represents a list of - # URLs to the license resource. Unlike regular licenses, user provided - # licenses can be modified after the disk is created. - "A String", - ], }, ], "displayDevice": { # A set of Display Device options # Display Device properties to enable support @@ -1405,7 +1395,7 @@Method Details
"A String", ], }, - "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values # have the same definition as resource # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and # values are in the format `tagValues/456`. The field is ignored (both PUT & @@ -1590,6 +1580,13 @@Method Details
"locations": { # Location configurations mapped by location name. # Currently only zone names are supported and must be represented as valid # internal URLs, such as zones/us-central1-a. + # The bulkInsert operation doesn't create instances in an AI zone, even if + # an AI zone is available in the specified region. For example, if you set a + # DENY preference for us-central1-a, Compute Engine will consider + # us-central1-b and us-central1-c for instance creation, but not + # us-central1-ai1a. Also, you can't use the locations[] configuration to + # allow instance creation in an AI zone. To include an AI zone in bulkInsert + # operations, use the locationPolicy.zones[] field. "a_key": { "constraints": { # Per-zone constraints on location policy for this zone. # Constraints that the caller requires on the result distribution # in this zone. @@ -1600,6 +1597,16 @@Method Details
}, }, "targetShape": "A String", # Strategy for distributing VMs across zones in a region. + "zones": [ # The bulkInsert operation applies any preferences set in the locations + # field to the specific zones listed in the zones field if the same zones + # are specified in both fields. + { + "zone": "A String", # The URL of the zone. + # The zone must exist in the region where the request is called. + # Zones must be represented as valid partial URLs, + # such as zones/us-central1-a. + }, + ], }, "minCount": "A String", # The minimum number of instances to create. If no min_count is # specified then count is used as the default value. Ifmin_count instances cannot be created, then no instances will diff --git a/docs/dyn/compute_beta.regionSnapshots.html b/docs/dyn/compute_beta.regionSnapshots.html index 5eb4fa02fe..cca4a00d9a 100644 --- a/docs/dyn/compute_beta.regionSnapshots.html +++ b/docs/dyn/compute_beta.regionSnapshots.html @@ -505,7 +505,7 @@Method Details
# be a dash. "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have # the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -585,6 +585,9 @@Method Details
# 4648 base64 encoded SHA-256 hash of the customer-supplied # encryption key that protects this resource. }, + "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot + # belongs to. + "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to. "snapshotType": "A String", # Indicates the type of the snapshot. "sourceDisk": "A String", # The source disk used to create this snapshot. "sourceDiskEncryptionKey": { # The customer-supplied @@ -730,10 +733,6 @@Method Details
# multi-regional). "A String", ], - "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of - # URLs to the license resource. - "A String", - ], }
delete(project, region, router, requestId=None, x__xgafv=None)
Deletes the specified Router resource.
+
+ deleteNamedSet(project, region, router, namedSet=None, requestId=None, x__xgafv=None)
Deletes Named Set
deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)
Deletes Route Policy
get(project, region, router, x__xgafv=None)
Returns the specified Router resource.
+
+ getNamedSet(project, region, router, namedSet=None, x__xgafv=None)
Returns specified Named Set
getNatIpInfo(project, region, router, natName=None, x__xgafv=None)
Retrieves runtime NAT IP information.
@@ -119,6 +125,12 @@Retrieves the next page of results.
+ +Retrieves a list of router named set subresources available to the
+ +Retrieves the next page of results.
Retrieves a list of router route policy subresources available to the
@@ -131,6 +143,9 @@
patch(project, region, router, body=None, requestId=None, x__xgafv=None)
Patches the specified Router resource with the data included in the
+
+ patchNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)
Patches Named Set
patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)
Patches Route Policy
@@ -143,6 +158,9 @@
update(project, region, router, body=None, requestId=None, x__xgafv=None)
Updates the specified Router resource with the data included in the
+
+ updateNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)
Updates or creates new Named Set
updateRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)
Updates or creates new Route Policy
@@ -1139,14 +1157,14 @@deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)
- Deletes Route Policy +deleteNamedSet(project, region, router, namedSet=None, requestId=None, x__xgafv=None)+Deletes Named Set Args: project: string, Project ID for this request. (required) region: string, Name of the region for this request. (required) - router: string, Name of the Router resource where Route Policy is defined. (required) - policy: string, The Policy name for this request. Name must conform to RFC1035 + router: string, Name of the Router resource where Named Set is defined. (required) + namedSet: string, The Named Set name for this request. Name must conform to RFC1035 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. @@ -1421,13 +1439,27 @@Method Details
get(project, region, router, x__xgafv=None)
- Returns the specified Router resource. +deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)+Deletes Route Policy Args: project: string, Project ID for this request. (required) region: string, Name of the region for this request. (required) - router: string, Name of the Router resource to return. (required) + router: string, Name of the Router resource where Route Policy is defined. (required) + policy: string, The Policy name for this request. Name must conform to RFC1035 + requestId: string, An optional request ID to identify requests. Specify a unique request ID so +that if you must retry your request, the server will know to ignore the +request if it has already been completed. + +For example, consider a situation where you make an initial request and +the request times out. If you make the request again with the same +request ID, the server can check if original operation with the same +request ID was received, and if so, will ignore the second request. This +prevents clients from accidentally creating duplicate commitments. + +The request ID must be +a valid UUID with the exception that zero UUID is not supported +(00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1436,106 +1468,374 @@+Method Details
Returns: An object of the form: - { # Represents a Cloud Router resource. + { # Represents an Operation resource. # - # For more information about Cloud Router, read theCloud - # Router overview. - "bgp": { # BGP information specific to this router. - "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. - # The options are DEFAULT or CUSTOM. - "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # is advertised to all peers of the router. - # These groups will be advertised in addition to any specified prefixes. - # Leave this field blank to advertise no custom groups. - "A String", - ], - "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # is advertised to all peers of the router. - # These IP ranges will be advertised in addition to any specified groups. - # Leave this field blank to advertise no custom IP ranges. - { # Description-tagged IP ranges for the router to advertise. - "description": "A String", # User-specified description for the IP range. - "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. + # Google Compute Engine has three Operation resources: + # + # * [Global](/compute/docs/reference/rest/beta/globalOperations) + # * [Regional](/compute/docs/reference/rest/beta/regionOperations) + # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) + # + # You can use an operation resource to manage asynchronous API requests. + # For more information, readHandling + # API responses. + # + # Operations can be global, regional or zonal. + # + # - For global operations, use the `globalOperations` + # resource. + # - For regional operations, use the + # `regionOperations` resource. + # - For zonal operations, use + # the `zoneOperations` resource. + # + # + # + # For more information, read + # Global, Regional, and Zonal Resources. + # + # Note that completed Operation resources have a limited + # retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. + # Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is + # set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 + # text format. + "error": { # [Output Only] If errors are generated during processing of the operation, + # this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. }, ], - "asn": 42, # Local BGP Autonomous System Number (ASN). - # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The - # value will be fixed for this router resource. All VPN tunnels that link - # to this router will have the same local ASN. - "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It - # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at - # least /30, even if the BGP sessions are over IPv6. It must not overlap - # with any IPv4 BGP session ranges. - # - # - # Other vendors commonly call this "router ID". - "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are - # sent to the peer. - # - # - # Hold time is three times the interval at which keepalive messages are - # sent, and the hold time is the maximum number of seconds allowed to - # elapse between successive keepalive messages that BGP receives from a - # peer. - # - # - # BGP will use the smaller of either the local hold time value or the - # peer's hold time value as the hold time for the BGP connection between - # the two peers. - # - # - # If set, this value must be between 20 and 60. The default is 20. }, - "bgpPeers": [ # BGP information that must be configured into the routing stack to - # establish BGP peering. This information must specify the peer ASN and - # either the interface name, IP address, or peer IP address. Please refer toRFC4273. - { - "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. - "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, - # which currently supports the following option: - # - # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This - # excludes any routes learned for subnets that use - # VPC Network Peering. - # - # - # Note that this field can only be populated if advertise_mode is CUSTOM - # and overrides the list defined for the router (in the "bgp" message). - # These groups are advertised in addition to any specified prefixes. - # Leave this field blank to advertise no custom groups. - "A String", - ], - "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # overrides the list defined for the router (in the "bgp" message). - # These IP ranges are advertised in addition to any specified groups. - # Leave this field blank to advertise no custom IP ranges. - { # Description-tagged IP ranges for the router to advertise. - "description": "A String", # User-specified description for the IP range. - "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. - }, - ], - "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more - # than one matching route of maximum length, the routes with the lowest - # priority value win. - "bfd": { # BFD configuration for the BGP peering. - "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets - # received from the peer router. The actual value is negotiated between - # the two routers and is equal to the greater of this value and the - # transmit interval of the other router. - # - # - # If set, this value must be between 1000 and 30000. - # - # - # The default is 1000. - "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets - # transmitted to the peer router. The actual value is negotiated between - # the two routers and is equal to the greater of this value and the - # corresponding receive interval of the other router. - # + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error + # message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error + # status code that was returned. For example, a `404` means the + # resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is + # defined by the server. + "insertTime": "A String", # [Output Only] The time that this operation was requested. + # This value is inRFC3339 + # text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an + # error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information + # if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. + }, + }, + }, + "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for + # Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a + # group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, + # `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. + # There is no requirement that this be linear or support any granularity of + # operations. This should not be used to guess when the operation will be + # complete. This number should monotonically increase as the operation + # progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only + # applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, + # this field will contain information on all underlying zonal actions and + # their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is + # populated. + # different programming environments, including REST APIs and RPC APIs. It is + # used by [gRPC](https://github.com/grpc). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + }, + "state": "A String", # [Output Only] Status of the action, which can be one of the following: + # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + }, + }, + }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. + # This value is inRFC3339 + # text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the + # following: + # `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the + # operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation + # of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For + # operations related to creating a snapshot, this points to the disk + # that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: + # `user@example.com` or + # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the + # operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, + ], + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only + # applicable when performing per-zone operations. +}
get(project, region, router, x__xgafv=None)
+ Returns the specified Router resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to return. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a Cloud Router resource.
+ #
+ # For more information about Cloud Router, read theCloud
+ # Router overview.
+ "bgp": { # BGP information specific to this router.
+ "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+ # The options are DEFAULT or CUSTOM.
+ "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # is advertised to all peers of the router.
+ # These groups will be advertised in addition to any specified prefixes.
+ # Leave this field blank to advertise no custom groups.
+ "A String",
+ ],
+ "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # is advertised to all peers of the router.
+ # These IP ranges will be advertised in addition to any specified groups.
+ # Leave this field blank to advertise no custom IP ranges.
+ { # Description-tagged IP ranges for the router to advertise.
+ "description": "A String", # User-specified description for the IP range.
+ "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+ },
+ ],
+ "asn": 42, # Local BGP Autonomous System Number (ASN).
+ # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
+ # value will be fixed for this router resource. All VPN tunnels that link
+ # to this router will have the same local ASN.
+ "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It
+ # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
+ # least /30, even if the BGP sessions are over IPv6. It must not overlap
+ # with any IPv4 BGP session ranges.
+ #
+ #
+ # Other vendors commonly call this "router ID".
+ "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are
+ # sent to the peer.
+ #
+ #
+ # Hold time is three times the interval at which keepalive messages are
+ # sent, and the hold time is the maximum number of seconds allowed to
+ # elapse between successive keepalive messages that BGP receives from a
+ # peer.
+ #
+ #
+ # BGP will use the smaller of either the local hold time value or the
+ # peer's hold time value as the hold time for the BGP connection between
+ # the two peers.
+ #
+ #
+ # If set, this value must be between 20 and 60. The default is 20.
+ },
+ "bgpPeers": [ # BGP information that must be configured into the routing stack to
+ # establish BGP peering. This information must specify the peer ASN and
+ # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
+ {
+ "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+ "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode,
+ # which currently supports the following option:
+ #
+ # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This
+ # excludes any routes learned for subnets that use
+ # VPC Network Peering.
+ #
+ #
+ # Note that this field can only be populated if advertise_mode is CUSTOM
+ # and overrides the list defined for the router (in the "bgp" message).
+ # These groups are advertised in addition to any specified prefixes.
+ # Leave this field blank to advertise no custom groups.
+ "A String",
+ ],
+ "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # overrides the list defined for the router (in the "bgp" message).
+ # These IP ranges are advertised in addition to any specified groups.
+ # Leave this field blank to advertise no custom IP ranges.
+ { # Description-tagged IP ranges for the router to advertise.
+ "description": "A String", # User-specified description for the IP range.
+ "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+ },
+ ],
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more
+ # than one matching route of maximum length, the routes with the lowest
+ # priority value win.
+ "bfd": { # BFD configuration for the BGP peering.
+ "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+ # received from the peer router. The actual value is negotiated between
+ # the two routers and is equal to the greater of this value and the
+ # transmit interval of the other router.
+ #
+ #
+ # If set, this value must be between 1000 and 30000.
+ #
+ #
+ # The default is 1000.
+ "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+ # transmitted to the peer router. The actual value is negotiated between
+ # the two routers and is equal to the greater of this value and the
+ # corresponding receive interval of the other router.
+ #
#
# If set, this value must be between 1000 and 30000.
#
@@ -1949,17 +2249,15 @@ Method Details
getNatIpInfo(project, region, router, natName=None, x__xgafv=None)
- Retrieves runtime NAT IP information. +getNamedSet(project, region, router, namedSet=None, x__xgafv=None)+Returns specified Named Set Args: project: string, Project ID for this request. (required) region: string, Name of the region for this request. (required) - router: string, Name of the Router resource to query for Nat IP information. The name -should conform to RFC1035. (required) - natName: string, Name of the nat service to filter the NAT IP information. -If it is omitted, all nats for this router will be returned. -Name should conform to RFC1035. + router: string, Name of the Router resource to query for the named set. The name should +conform to RFC1035. (required) + namedSet: string, The Named Set name for this request. Name must conform to RFC1035 x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1969,19 +2267,103 @@+Method Details
An object of the form: { - "result": [ # [Output Only] A list of NAT IP information. - { # Contains NAT IP information of a NAT config (i.e. usage status, mode). - "natIpInfoMappings": [ # Output only. A list of all NAT IPs assigned to this NAT config. - { # Contains information of a NAT IP. - "mode": "A String", # Output only. Specifies whether NAT IP is auto or manual. - "natIp": "A String", # Output only. NAT IP address. For example: 203.0.113.11. - "usage": "A String", # Output only. Specifies whether NAT IP is currently serving at least one endpoint or - # not. - }, - ], - "natName": "A String", # Output only. Name of the NAT config which the NAT IP belongs to. - }, - ], + "etag": "A String", # end_interface: MixerGetResponseWithEtagBuilder + "resource": { + "description": "A String", # An optional description of named set. + "elements": [ # CEL expressions that are comparable to constructs of this set's type + # (see Policy Language). + { # Represents a textual expression in the Common Expression Language (CEL) + # syntax. CEL is a C-like expression language. The syntax and semantics of CEL + # are documented at https://github.com/google/cel-spec. + # + # Example (Comparison): + # + # title: "Summary size limit" + # description: "Determines if a summary is less than 100 chars" + # expression: "document.summary.size() < 100" + # + # Example (Equality): + # + # title: "Requestor is owner" + # description: "Determines if requestor is the document owner" + # expression: "document.owner == request.auth.claims.email" + # + # Example (Logic): + # + # title: "Public documents" + # description: "Determine whether the document should be publicly visible" + # expression: "document.type != 'private' && document.type != 'internal'" + # + # Example (Data Manipulation): + # + # title: "Notification string" + # description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" + # + # The exact variables and functions that may be referenced within an expression + # are determined by the service that evaluates it. See the service + # documentation for additional information. + "description": "A String", # Optional. Description of the expression. This is a longer text which + # describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language + # syntax. + "location": "A String", # Optional. String indicating the location of the expression for error + # reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing + # its purpose. This can be used e.g. in UIs which allow to enter the + # expression. + }, + ], + "fingerprint": "A String", # A fingerprint for the Named Set being applied to this Router, which is + # essentially a hash of the Named Set used for optimistic locking. + # The fingerprint is initially generated by Compute Engine and changes + # after every request to modify or update the Named Set. You must always + # provide an up-to-date fingerprint hash in order to update or change + # labels. + # + # To see the latest fingerprint, make a getNamedSet() request + # to retrieve a Named Set. + "name": "A String", # This set's name, which must be a resource ID segment and unique within all + # named sets owned by the Router. Name should conform to RFC1035. + "type": "A String", # This named set's type + }, +}
getNatIpInfo(project, region, router, natName=None, x__xgafv=None)
+ Retrieves runtime NAT IP information.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to query for Nat IP information. The name
+should conform to RFC1035. (required)
+ natName: string, Name of the nat service to filter the NAT IP information.
+If it is omitted, all nats for this router will be returned.
+Name should conform to RFC1035.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "result": [ # [Output Only] A list of NAT IP information.
+ { # Contains NAT IP information of a NAT config (i.e. usage status, mode).
+ "natIpInfoMappings": [ # Output only. A list of all NAT IPs assigned to this NAT config.
+ { # Contains information of a NAT IP.
+ "mode": "A String", # Output only. Specifies whether NAT IP is auto or manual.
+ "natIp": "A String", # Output only. NAT IP address. For example: 203.0.113.11.
+ "usage": "A String", # Output only. Specifies whether NAT IP is currently serving at least one endpoint or
+ # not.
+ },
+ ],
+ "natName": "A String", # Output only. Name of the NAT config which the NAT IP belongs to.
+ },
+ ],
}
listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
- Retrieves a list of router route policy subresources available to the +listNamedSets(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)+Retrieves a list of router named set subresources available to the specified project. Args: @@ -4788,121 +5170,71 @@Method Details
"etag": "A String", "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "kind": "compute#routersListRoutePolicies", # Output only. [Output Only] Type of resource. Alwayscompute#routersListRoutePolicies for lists of route policies. + "kind": "compute#routersListNamedSets", # Output only. [Output Only] Type of resource. Alwayscompute#routersListNamedSets for lists of named sets. "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for # the query parameter pageToken in the next list request. # Subsequent list requests will have their own nextPageToken to # continue paging through the results. - "result": [ # [Output Only] A list of route policies. + "result": [ # [Output Only] A list of named sets. { - "description": "A String", # An optional description of route policy. - "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is - # essentially a hash of the Route Policy used for optimistic locking. + "description": "A String", # An optional description of named set. + "elements": [ # CEL expressions that are comparable to constructs of this set's type + # (see Policy Language). + { # Represents a textual expression in the Common Expression Language (CEL) + # syntax. CEL is a C-like expression language. The syntax and semantics of CEL + # are documented at https://github.com/google/cel-spec. + # + # Example (Comparison): + # + # title: "Summary size limit" + # description: "Determines if a summary is less than 100 chars" + # expression: "document.summary.size() < 100" + # + # Example (Equality): + # + # title: "Requestor is owner" + # description: "Determines if requestor is the document owner" + # expression: "document.owner == request.auth.claims.email" + # + # Example (Logic): + # + # title: "Public documents" + # description: "Determine whether the document should be publicly visible" + # expression: "document.type != 'private' && document.type != 'internal'" + # + # Example (Data Manipulation): + # + # title: "Notification string" + # description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" + # + # The exact variables and functions that may be referenced within an expression + # are determined by the service that evaluates it. See the service + # documentation for additional information. + "description": "A String", # Optional. Description of the expression. This is a longer text which + # describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language + # syntax. + "location": "A String", # Optional. String indicating the location of the expression for error + # reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing + # its purpose. This can be used e.g. in UIs which allow to enter the + # expression. + }, + ], + "fingerprint": "A String", # A fingerprint for the Named Set being applied to this Router, which is + # essentially a hash of the Named Set used for optimistic locking. # The fingerprint is initially generated by Compute Engine and changes - # after every request to modify or update Route Policy. You must always + # after every request to modify or update the Named Set. You must always # provide an up-to-date fingerprint hash in order to update or change # labels. # - # To see the latest fingerprint, make a getRoutePolicy() request - # to retrieve a Route Policy. - "name": "A String", # Route Policy name, which must be a resource ID segment and unique - # within all the router's Route Policies. Name should conform to RFC1035. - "terms": [ # List of terms (the order in the list is not important, they are evaluated - # in order of priority). Order of policies is not retained and might change - # when getting policy later. - { - "actions": [ # CEL expressions to evaluate to modify a route when this term matches. - { # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # - # Example (Comparison): - # - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # - # Example (Equality): - # - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # - # Example (Logic): - # - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # - # Example (Data Manipulation): - # - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. - "description": "A String", # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language - # syntax. - "location": "A String", # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing - # its purpose. This can be used e.g. in UIs which allow to enter the - # expression. - }, - ], - "match": { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term - # applies. When not set, the term applies to all - # routes. - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # - # Example (Comparison): - # - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # - # Example (Equality): - # - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # - # Example (Logic): - # - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # - # Example (Data Manipulation): - # - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. - "description": "A String", # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language - # syntax. - "location": "A String", # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing - # its purpose. This can be used e.g. in UIs which allow to enter the - # expression. - }, - "priority": 42, # The evaluation priority for this term, which must be between 0 - # (inclusive) and 2^31 (exclusive), and unique within the list. - }, - ], - "type": "A String", + # To see the latest fingerprint, make a getNamedSet() request + # to retrieve a Named Set. + "name": "A String", # This set's name, which must be a resource ID segment and unique within all + # named sets owned by the Router. Name should conform to RFC1035. + "type": "A String", # This named set's type }, ], "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. @@ -4938,21 +5270,7 @@Method Details
listRoutePolicies_next()
- Retrieves the next page of results. - - Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - - Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
list_next()
+ listNamedSets_next()
Retrieves the next page of results.
Args:
@@ -4966,395 +5284,677 @@ Method Details
patch(project, region, router, body=None, requestId=None, x__xgafv=None)
- Patches the specified Router resource with the data included in the -request. This method supportsPATCH -semantics and usesJSON merge -patch format and processing rules. +listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)+Retrieves a list of router route policy subresources available to the +specified project. Args: project: string, Project ID for this request. (required) region: string, Name of the region for this request. (required) - router: string, Name of the Router resource to patch. (required) - body: object, The request body. - The object takes the form of: + router: string, Name or id of the resource for this request. +Name should conform to RFC1035. (required) + filter: string, A filter expression that filters resources listed in the response. Most +Compute resources support two types of filter expressions: +expressions that support regular expressions and expressions that follow +API improvement proposal AIP-160. +These two types of filter expressions cannot be mixed in one request. + +If you want to use AIP-160, your expression must specify the field name, an +operator, and the value that you want to use for filtering. The value +must be a string, a number, or a boolean. The operator +must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. + +For example, if you are filtering Compute Engine instances, you can +exclude instances named `example-instance` by specifying +`name != example-instance`. + +The `:*` comparison can be used to test whether a key has been defined. +For example, to find all objects with `owner` label use: +``` +labels.owner:* +``` + +You can also filter nested fields. For example, you could specify +`scheduling.automaticRestart = false` to include instances only +if they are not scheduled for automatic restarts. You can use filtering +on nested fields to filter based onresource labels. + +To filter on multiple expressions, provide each separate expression within +parentheses. For example: +``` +(scheduling.automaticRestart = true) +(cpuPlatform = "Intel Skylake") +``` +By default, each expression is an `AND` expression. However, you +can include `AND` and `OR` expressions explicitly. +For example: +``` +(cpuPlatform = "Intel Skylake") OR +(cpuPlatform = "Intel Broadwell") AND +(scheduling.automaticRestart = true) +``` + +If you want to use a regular expression, use the `eq` (equal) or `ne` +(not equal) operator against a single un-parenthesized expression with or +without quotes or against multiple parenthesized expressions. Examples: + +`fieldname eq unquoted literal` +`fieldname eq 'single quoted literal'` +`fieldname eq "double quoted literal"` +`(fieldname1 eq literal) (fieldname2 ne "literal")` + +The literal value is interpreted as a regular expression using GoogleRE2 library syntax. +The literal value must match the entire field. + +For example, to filter for instances that do not end with name "instance", +you would use `name ne .*instance`. + +You cannot combine constraints on multiple fields using regular +expressions. + maxResults: integer, The maximum number of results per page that should be returned. +If the number of available results is larger than `maxResults`, +Compute Engine returns a `nextPageToken` that can be used to get +the next page of results in subsequent list requests. Acceptable values are +`0` to `500`, inclusive. (Default: `500`) + orderBy: string, Sorts list results by a certain order. By default, results +are returned in alphanumerical order based on the resource name. + +You can also sort results in descending order based on the creation +timestamp using `orderBy="creationTimestamp desc"`. This sorts +results based on the `creationTimestamp` field in +reverse chronological order (newest result first). Use this to sort +resources like operations so that the newest operation is returned first. + +Currently, only sorting by `name` or +`creationTimestamp desc` is supported. + pageToken: string, Specifies a page token to use. Set `pageToken` to the +`nextPageToken` returned by a previous list request to get +the next page of results. + returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case +of failure. The default value is false. + +For example, when partial success behavior is enabled, aggregatedList for a +single zone scope either returns all resources in the zone or no resources, +with an error code. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: -{ # Represents a Cloud Router resource. - # - # For more information about Cloud Router, read theCloud - # Router overview. - "bgp": { # BGP information specific to this router. - "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. - # The options are DEFAULT or CUSTOM. - "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # is advertised to all peers of the router. - # These groups will be advertised in addition to any specified prefixes. - # Leave this field blank to advertise no custom groups. - "A String", - ], - "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # is advertised to all peers of the router. - # These IP ranges will be advertised in addition to any specified groups. - # Leave this field blank to advertise no custom IP ranges. - { # Description-tagged IP ranges for the router to advertise. - "description": "A String", # User-specified description for the IP range. - "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. - }, - ], - "asn": 42, # Local BGP Autonomous System Number (ASN). - # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The - # value will be fixed for this router resource. All VPN tunnels that link - # to this router will have the same local ASN. - "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It - # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at - # least /30, even if the BGP sessions are over IPv6. It must not overlap - # with any IPv4 BGP session ranges. - # - # - # Other vendors commonly call this "router ID". - "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are - # sent to the peer. - # - # - # Hold time is three times the interval at which keepalive messages are - # sent, and the hold time is the maximum number of seconds allowed to - # elapse between successive keepalive messages that BGP receives from a - # peer. - # - # - # BGP will use the smaller of either the local hold time value or the - # peer's hold time value as the hold time for the BGP connection between - # the two peers. - # - # - # If set, this value must be between 20 and 60. The default is 20. - }, - "bgpPeers": [ # BGP information that must be configured into the routing stack to - # establish BGP peering. This information must specify the peer ASN and - # either the interface name, IP address, or peer IP address. Please refer toRFC4273. { - "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. - "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, - # which currently supports the following option: - # - # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This - # excludes any routes learned for subnets that use - # VPC Network Peering. - # + "etag": "A String", + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. + "kind": "compute#routersListRoutePolicies", # Output only. [Output Only] Type of resource. Alwayscompute#routersListRoutePolicies for lists of route policies. + "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for + # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for + # the query parameter pageToken in the next list request. + # Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + "result": [ # [Output Only] A list of route policies. + { + "description": "A String", # An optional description of route policy. + "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is + # essentially a hash of the Route Policy used for optimistic locking. + # The fingerprint is initially generated by Compute Engine and changes + # after every request to modify or update Route Policy. You must always + # provide an up-to-date fingerprint hash in order to update or change + # labels. # - # Note that this field can only be populated if advertise_mode is CUSTOM - # and overrides the list defined for the router (in the "bgp" message). - # These groups are advertised in addition to any specified prefixes. - # Leave this field blank to advertise no custom groups. - "A String", - ], - "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # overrides the list defined for the router (in the "bgp" message). - # These IP ranges are advertised in addition to any specified groups. - # Leave this field blank to advertise no custom IP ranges. - { # Description-tagged IP ranges for the router to advertise. - "description": "A String", # User-specified description for the IP range. - "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. - }, - ], - "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more - # than one matching route of maximum length, the routes with the lowest - # priority value win. - "bfd": { # BFD configuration for the BGP peering. - "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets - # received from the peer router. The actual value is negotiated between - # the two routers and is equal to the greater of this value and the - # transmit interval of the other router. - # - # - # If set, this value must be between 1000 and 30000. - # - # - # The default is 1000. - "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets - # transmitted to the peer router. The actual value is negotiated between - # the two routers and is equal to the greater of this value and the - # corresponding receive interval of the other router. - # - # - # If set, this value must be between 1000 and 30000. - # - # - # The default is 1000. - "multiplier": 42, # The number of consecutive BFD packets that must be missed - # before BFD declares that a peer is unavailable. - # - # - # If set, the value must be a value between 5 and 16. - # - # - # The default is 5. - "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. - # - # - # If set to ACTIVE, the Cloud Router will initiate the BFD session for - # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the - # peer router to initiate the BFD session for this BGP peer. If set to - # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. - }, - "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP - # session. + # To see the latest fingerprint, make a getRoutePolicy() request + # to retrieve a Route Policy. + "name": "A String", # Route Policy name, which must be a resource ID segment and unique + # within all the router's Route Policies. Name should conform to RFC1035. + "terms": [ # List of terms (the order in the list is not important, they are evaluated + # in order of priority). Order of policies is not retained and might change + # when getting policy later. { - "range": "A String", # The custom learned route IP address range. Must be a valid - # CIDR-formatted prefix. If an IP address is provided without a subnet - # mask, it is interpreted as, for IPv4, a `/32` singular IP address - # range, and, for IPv6, `/128`. - }, - ], - "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This - # value is applied to all custom learned route ranges for the session. - # You can choose a value from `0` to `65335`. If you don't provide a - # value, Google Cloud assigns a priority of `100` to the ranges. - "enable": "A String", # The status of the BGP peer connection. - # - # - # If set to FALSE, any active session with the peer is terminated and - # all associated routing information is removed. If set to TRUE, the - # peer connection can be established with routing information. The default - # is TRUE. - "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if - # the peerIpAddress is version 4. - "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the - # peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be - # evaluated. The name must correspond to an existing policy that has - # ROUTE_POLICY_TYPE_EXPORT type. - "A String", - ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be - # evaluated. The name must correspond to an existing policy that has - # ROUTE_POLICY_TYPE_IMPORT type. - "A String", + "actions": [ # CEL expressions to evaluate to modify a route when this term matches. + { # Represents a textual expression in the Common Expression Language (CEL) + # syntax. CEL is a C-like expression language. The syntax and semantics of CEL + # are documented at https://github.com/google/cel-spec. + # + # Example (Comparison): + # + # title: "Summary size limit" + # description: "Determines if a summary is less than 100 chars" + # expression: "document.summary.size() < 100" + # + # Example (Equality): + # + # title: "Requestor is owner" + # description: "Determines if requestor is the document owner" + # expression: "document.owner == request.auth.claims.email" + # + # Example (Logic): + # + # title: "Public documents" + # description: "Determine whether the document should be publicly visible" + # expression: "document.type != 'private' && document.type != 'internal'" + # + # Example (Data Manipulation): + # + # title: "Notification string" + # description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" + # + # The exact variables and functions that may be referenced within an expression + # are determined by the service that evaluates it. See the service + # documentation for additional information. + "description": "A String", # Optional. Description of the expression. This is a longer text which + # describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language + # syntax. + "location": "A String", # Optional. String indicating the location of the expression for error + # reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing + # its purpose. This can be used e.g. in UIs which allow to enter the + # expression. + }, + ], + "match": { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term + # applies. When not set, the term applies to all + # routes. + # syntax. CEL is a C-like expression language. The syntax and semantics of CEL + # are documented at https://github.com/google/cel-spec. + # + # Example (Comparison): + # + # title: "Summary size limit" + # description: "Determines if a summary is less than 100 chars" + # expression: "document.summary.size() < 100" + # + # Example (Equality): + # + # title: "Requestor is owner" + # description: "Determines if requestor is the document owner" + # expression: "document.owner == request.auth.claims.email" + # + # Example (Logic): + # + # title: "Public documents" + # description: "Determine whether the document should be publicly visible" + # expression: "document.type != 'private' && document.type != 'internal'" + # + # Example (Data Manipulation): + # + # title: "Notification string" + # description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" + # + # The exact variables and functions that may be referenced within an expression + # are determined by the service that evaluates it. See the service + # documentation for additional information. + "description": "A String", # Optional. Description of the expression. This is a longer text which + # describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language + # syntax. + "location": "A String", # Optional. String indicating the location of the expression for error + # reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing + # its purpose. This can be used e.g. in UIs which allow to enter the + # expression. + }, + "priority": 42, # The evaluation priority for this term, which must be between 0 + # (inclusive) and 2^31 (exclusive), and unique within the list. + }, ], - "interfaceName": "A String", # Name of the interface the BGP peer is associated with. - "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. - "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. - "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. - "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. - # - # - MANAGED_BY_USER is the default value and can be managed by you - # or other users - # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed - # by Cloud Interconnect, specifically by an InterconnectAttachment of type - # PARTNER. Google automatically creates, updates, and deletes this type of - # BGP peer when the PARTNER InterconnectAttachment is created, updated, - # or deleted. - "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the - # name of one of the entries in the Router.md5_authentication_keys. The - # field must comply with RFC1035. - "name": "A String", # Name of this BGP peer. - # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 - # characters long and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - # lowercase letter, and all following characters must be a dash, lowercase - # letter, or digit, except the last character, which cannot be a dash. - "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use - # a different value. - "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. - "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. - "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. - "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router - # appliances such as Next Gen Firewalls, Virtual Routers, or Router - # Appliances. The VM instance must be located in zones contained in the - # same region as this Cloud Router. - # The VM instance is the peer side of the BGP session. - }, - ], - "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 - # text format. - "description": "A String", # An optional description of this resource. Provide this property when you - # create the resource. - "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN - # attachments (interconnectAttachments). - "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is - # defined by the server. - "interfaces": [ # Router interfaces. - # To create a BGP peer that uses a router interface, - # the interface must have one of the following fields specified: - # - # - linkedVpnTunnel - # - linkedInterconnectAttachment - # - subnetwork - # - # - # You can create a router interface without any of these fields specified. - # However, you cannot create a BGP peer that uses that interface. - { - "ipRange": "A String", # IP address and range of the interface. - # - # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must - # be a CIDR-formatted string, for example, 169.254.0.1/30. - # Note: Do not truncate the IP address, as it represents the IP address of - # the interface. - # - For Internet Protocol version 6 (IPv6), the value - # must be a unique local address (ULA) range from fdff:1::/64 - # with a mask length of 126 or less. This value should be a CIDR-formatted - # string, for example, fdff:1::1/112. Within the router's - # VPC, this IPv6 prefix will be reserved exclusively for this connection - # and cannot be used for any other purpose. - "ipVersion": "A String", # IP version of this interface. - "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region - # as the router. Each interface can have one linked resource, which can be - # a VPN tunnel, an Interconnect attachment, or a subnetwork. - "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the - # router. Each interface can have one linked resource, which can be - # a VPN tunnel, an Interconnect attachment, or a subnetwork. - "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. - # - # - MANAGED_BY_USER is the default value and can be managed directly - # by users. - # - MANAGED_BY_ATTACHMENT is an interface that is configured and - # managed by Cloud Interconnect, specifically, by an InterconnectAttachment - # of type PARTNER. Google automatically creates, updates, and deletes - # this type of interface when the PARTNER InterconnectAttachment is - # created, updated, or deleted. - "name": "A String", # Name of this interface entry. - # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 - # characters long and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - # lowercase letter, and all following characters must be a dash, lowercase - # letter, or digit, except the last character, which cannot be a dash. - "privateIpAddress": "A String", # The regional private internal IP address that is used to establish - # BGP sessions to a VM instance acting as a third-party - # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or - # an SD-WAN VM. - "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface - # you are creating. The redundantInterface must belong to the same Cloud - # Router as the interface here. To establish the BGP session to a Router - # Appliance VM, you must create two BGP peers. The two BGP peers must be - # attached to two separate interfaces that are redundant with each other. - # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must - # be 1-63 characters long and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - # lowercase letter, and all following characters must be a dash, lowercase - # letter, or digit, except the last character, which cannot be a dash. - "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which - # must be in the same region as the Cloud Router. - # When you establish a BGP session to a VM instance using this interface, - # the VM instance must belong to the same subnetwork as the subnetwork - # specified here. + "type": "A String", }, ], - "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for - # routers. - "md5AuthenticationKeys": [ # Keys used for MD5 authentication. - { - "key": "A String", # [Input only] Value of the key. - # - # For patch and update calls, it can be skipped to - # copy the value from the previous configuration. This is allowed if the - # key with the same name existed before the operation. Maximum length is 80 - # characters. Can only contain printable ASCII characters. - "name": "A String", # Name used to identify the key. - # - # Must be unique within a router. Must be referenced by exactly - # one bgpPeer. Must comply withRFC1035. - }, + "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. + "unreachables": [ # Output only. [Output Only] Unreachable resources. + "A String", ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. - # The name must be 1-63 characters long, and comply withRFC1035. - # Specifically, the name must be 1-63 characters long and match the regular - # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - # character must be a lowercase letter, and all following characters must - # be a dash, lowercase letter, or digit, except the last character, which - # cannot be a dash. - "nats": [ # A list of NAT services created in this router. - { # Represents a Nat resource. It enables the VMs within the specified - # subnetworks to access Internet without external IP addresses. It specifies - # a list of subnetworks (and the ranges within) that want to use NAT. - # Customers can also provide the external IPs that would be used for NAT. GCP - # would auto-allocate ephemeral IPs if no external IPs are provided. - "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses. - # Must be one of: PREMIUM, STANDARD. - # If not specified, then the current - # project-level default tier is used. - "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs - # must be valid static external IPs that have been assigned to the NAT. - # These IPs should be used for updating/patching a NAT only. - "A String", - ], - "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. - # - # - # If not specified, it is disabled by default. + "warning": { # [Output Only] Informational warning message. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, +}+
listRoutePolicies_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(project, region, router, body=None, requestId=None, x__xgafv=None)
+ Patches the specified Router resource with the data included in the
+request. This method supportsPATCH
+semantics and usesJSON merge
+patch format and processing rules.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to patch. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Cloud Router resource.
+ #
+ # For more information about Cloud Router, read theCloud
+ # Router overview.
+ "bgp": { # BGP information specific to this router.
+ "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+ # The options are DEFAULT or CUSTOM.
+ "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # is advertised to all peers of the router.
+ # These groups will be advertised in addition to any specified prefixes.
+ # Leave this field blank to advertise no custom groups.
+ "A String",
+ ],
+ "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # is advertised to all peers of the router.
+ # These IP ranges will be advertised in addition to any specified groups.
+ # Leave this field blank to advertise no custom IP ranges.
+ { # Description-tagged IP ranges for the router to advertise.
+ "description": "A String", # User-specified description for the IP range.
+ "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+ },
+ ],
+ "asn": 42, # Local BGP Autonomous System Number (ASN).
+ # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
+ # value will be fixed for this router resource. All VPN tunnels that link
+ # to this router will have the same local ASN.
+ "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It
+ # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
+ # least /30, even if the BGP sessions are over IPv6. It must not overlap
+ # with any IPv4 BGP session ranges.
+ #
+ #
+ # Other vendors commonly call this "router ID".
+ "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are
+ # sent to the peer.
+ #
+ #
+ # Hold time is three times the interval at which keepalive messages are
+ # sent, and the hold time is the maximum number of seconds allowed to
+ # elapse between successive keepalive messages that BGP receives from a
+ # peer.
+ #
+ #
+ # BGP will use the smaller of either the local hold time value or the
+ # peer's hold time value as the hold time for the BGP connection between
+ # the two peers.
+ #
+ #
+ # If set, this value must be between 20 and 60. The default is 20.
+ },
+ "bgpPeers": [ # BGP information that must be configured into the routing stack to
+ # establish BGP peering. This information must specify the peer ASN and
+ # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
+ {
+ "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+ "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode,
+ # which currently supports the following option:
#
+ # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This
+ # excludes any routes learned for subnets that use
+ # VPC Network Peering.
#
- # If set to true,
#
- # - Dynamic Port Allocation will be enabled on this NAT
- # config.
- # - enableEndpointIndependentMapping cannot be set to true.
- # - If minPorts is set, minPortsPerVm must be set to a
- # power of two greater than or equal to 32. If minPortsPerVm is not set, a
- # minimum of 32 ports will be allocated to a VM from this NAT
- # config.
- "enableEndpointIndependentMapping": True or False,
- "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
- # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
+ # Note that this field can only be populated if advertise_mode is CUSTOM
+ # and overrides the list defined for the router (in the "bgp" message).
+ # These groups are advertised in addition to any specified prefixes.
+ # Leave this field blank to advertise no custom groups.
"A String",
],
- "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
- "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.
- "enable": True or False, # Indicates whether or not to export logs. This is false by default.
- "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified,
- # logs are exported for all connections handled by this NAT.
- # This option can take one of the following values:
+ "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # overrides the list defined for the router (in the "bgp" message).
+ # These IP ranges are advertised in addition to any specified groups.
+ # Leave this field blank to advertise no custom IP ranges.
+ { # Description-tagged IP ranges for the router to advertise.
+ "description": "A String", # User-specified description for the IP range.
+ "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+ },
+ ],
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more
+ # than one matching route of maximum length, the routes with the lowest
+ # priority value win.
+ "bfd": { # BFD configuration for the BGP peering.
+ "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+ # received from the peer router. The actual value is negotiated between
+ # the two routers and is equal to the greater of this value and the
+ # transmit interval of the other router.
#
- # - ERRORS_ONLY: Export logs only for connection failures.
- # - TRANSLATIONS_ONLY: Export logs only for successful
- # connections.
- # - ALL: Export logs for all connections, successful and
- # unsuccessful.
+ #
+ # If set, this value must be between 1000 and 30000.
+ #
+ #
+ # The default is 1000.
+ "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+ # transmitted to the peer router. The actual value is negotiated between
+ # the two routers and is equal to the greater of this value and the
+ # corresponding receive interval of the other router.
+ #
+ #
+ # If set, this value must be between 1000 and 30000.
+ #
+ #
+ # The default is 1000.
+ "multiplier": 42, # The number of consecutive BFD packets that must be missed
+ # before BFD declares that a peer is unavailable.
+ #
+ #
+ # If set, the value must be a value between 5 and 16.
+ #
+ #
+ # The default is 5.
+ "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.
+ #
+ #
+ # If set to ACTIVE, the Cloud Router will initiate the BFD session for
+ # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
+ # peer router to initiate the BFD session for this BGP peer. If set to
+ # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
},
- "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when
- # Dynamic Port Allocation is enabled.
- #
- #
- # If Dynamic Port Allocation is not enabled, this field has no effect.
- #
- #
- # If Dynamic Port Allocation is enabled, and this field is set, it must be
- # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
- # is not set.
- #
- #
- # If Dynamic Port Allocation is enabled and this field is not set,
- # a maximum of 65536 ports will be allocated to a VM from this NAT
- # config.
- "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not
- # set, a default number of ports is allocated to a VM. This is rounded
- # up to the nearest power of 2. For example, if the value of this field is
- # 50, at least 64 ports are allocated to a VM.
- "name": "A String", # Unique name of this Nat service.
- # The name must be 1-63 characters long and comply withRFC1035.
- "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64
- # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
- # selected for the SubnetworkIpRangeToNat64Option above.
- { # Specifies a subnetwork to enable NAT64.
- "name": "A String", # URL for the subnetwork resource that will use NAT64.
+ "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP
+ # session.
+ {
+ "range": "A String", # The custom learned route IP address range. Must be a valid
+ # CIDR-formatted prefix. If an IP address is provided without a subnet
+ # mask, it is interpreted as, for IPv4, a `/32` singular IP address
+ # range, and, for IPv6, `/128`.
},
],
- "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following
- # values:
+ "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This
+ # value is applied to all custom learned route ranges for the session.
+ # You can choose a value from `0` to `65335`. If you don't provide a
+ # value, Google Cloud assigns a priority of `100` to the ranges.
+ "enable": "A String", # The status of the BGP peer connection.
#
- # - MANUAL_ONLY: Uses only Nat IP addresses provided by
- # customers. When there are not enough specified Nat IPs, the Nat service
- # fails for new VMs.
- # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
- # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
- # be empty.
- "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP
- # addresses must be valid static external IP addresses assigned to the
- # project.
- "A String",
+ #
+ # If set to FALSE, any active session with the peer is terminated and
+ # all associated routing information is removed. If set to TRUE, the
+ # peer connection can be established with routing information. The default
+ # is TRUE.
+ "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
+ # the peerIpAddress is version 4.
+ "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
+ # peerIpAddress is version 6.
+ "exportPolicies": [ # List of export policies applied to this peer, in the order they must be
+ # evaluated. The name must correspond to an existing policy that has
+ # ROUTE_POLICY_TYPE_EXPORT type.
+ "A String",
+ ],
+ "importPolicies": [ # List of import policies applied to this peer, in the order they must be
+ # evaluated. The name must correspond to an existing policy that has
+ # ROUTE_POLICY_TYPE_IMPORT type.
+ "A String",
+ ],
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
+ "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
+ "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer.
+ #
+ # - MANAGED_BY_USER is the default value and can be managed by you
+ # or other users
+ # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
+ # by Cloud Interconnect, specifically by an InterconnectAttachment of type
+ # PARTNER. Google automatically creates, updates, and deletes this type of
+ # BGP peer when the PARTNER InterconnectAttachment is created, updated,
+ # or deleted.
+ "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the
+ # name of one of the entries in the Router.md5_authentication_keys. The
+ # field must comply with RFC1035.
+ "name": "A String", # Name of this BGP peer.
+ # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
+ # characters long and match the regular expression
+ # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+ # lowercase letter, and all following characters must be a dash, lowercase
+ # letter, or digit, except the last character, which cannot be a dash.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
+ # a different value.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform.
+ "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform.
+ "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform.
+ "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router
+ # appliances such as Next Gen Firewalls, Virtual Routers, or Router
+ # Appliances. The VM instance must be located in zones contained in the
+ # same region as this Cloud Router.
+ # The VM instance is the peer side of the BGP session.
+ },
+ ],
+ "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+ # text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you
+ # create the resource.
+ "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN
+ # attachments (interconnectAttachments).
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+ # defined by the server.
+ "interfaces": [ # Router interfaces.
+ # To create a BGP peer that uses a router interface,
+ # the interface must have one of the following fields specified:
+ #
+ # - linkedVpnTunnel
+ # - linkedInterconnectAttachment
+ # - subnetwork
+ #
+ #
+ # You can create a router interface without any of these fields specified.
+ # However, you cannot create a BGP peer that uses that interface.
+ {
+ "ipRange": "A String", # IP address and range of the interface.
+ #
+ # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
+ # be a CIDR-formatted string, for example, 169.254.0.1/30.
+ # Note: Do not truncate the IP address, as it represents the IP address of
+ # the interface.
+ # - For Internet Protocol version 6 (IPv6), the value
+ # must be a unique local address (ULA) range from fdff:1::/64
+ # with a mask length of 126 or less. This value should be a CIDR-formatted
+ # string, for example, fdff:1::1/112. Within the router's
+ # VPC, this IPv6 prefix will be reserved exclusively for this connection
+ # and cannot be used for any other purpose.
+ "ipVersion": "A String", # IP version of this interface.
+ "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region
+ # as the router. Each interface can have one linked resource, which can be
+ # a VPN tunnel, an Interconnect attachment, or a subnetwork.
+ "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the
+ # router. Each interface can have one linked resource, which can be
+ # a VPN tunnel, an Interconnect attachment, or a subnetwork.
+ "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface.
+ #
+ # - MANAGED_BY_USER is the default value and can be managed directly
+ # by users.
+ # - MANAGED_BY_ATTACHMENT is an interface that is configured and
+ # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
+ # of type PARTNER. Google automatically creates, updates, and deletes
+ # this type of interface when the PARTNER InterconnectAttachment is
+ # created, updated, or deleted.
+ "name": "A String", # Name of this interface entry.
+ # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
+ # characters long and match the regular expression
+ # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+ # lowercase letter, and all following characters must be a dash, lowercase
+ # letter, or digit, except the last character, which cannot be a dash.
+ "privateIpAddress": "A String", # The regional private internal IP address that is used to establish
+ # BGP sessions to a VM instance acting as a third-party
+ # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
+ # an SD-WAN VM.
+ "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface
+ # you are creating. The redundantInterface must belong to the same Cloud
+ # Router as the interface here. To establish the BGP session to a Router
+ # Appliance VM, you must create two BGP peers. The two BGP peers must be
+ # attached to two separate interfaces that are redundant with each other.
+ # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
+ # be 1-63 characters long and match the regular expression
+ # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+ # lowercase letter, and all following characters must be a dash, lowercase
+ # letter, or digit, except the last character, which cannot be a dash.
+ "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which
+ # must be in the same region as the Cloud Router.
+ # When you establish a BGP session to a VM instance using this interface,
+ # the VM instance must belong to the same subnetwork as the subnetwork
+ # specified here.
+ },
+ ],
+ "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for
+ # routers.
+ "md5AuthenticationKeys": [ # Keys used for MD5 authentication.
+ {
+ "key": "A String", # [Input only] Value of the key.
+ #
+ # For patch and update calls, it can be skipped to
+ # copy the value from the previous configuration. This is allowed if the
+ # key with the same name existed before the operation. Maximum length is 80
+ # characters. Can only contain printable ASCII characters.
+ "name": "A String", # Name used to identify the key.
+ #
+ # Must be unique within a router. Must be referenced by exactly
+ # one bgpPeer. Must comply withRFC1035.
+ },
+ ],
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+ # The name must be 1-63 characters long, and comply withRFC1035.
+ # Specifically, the name must be 1-63 characters long and match the regular
+ # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+ # character must be a lowercase letter, and all following characters must
+ # be a dash, lowercase letter, or digit, except the last character, which
+ # cannot be a dash.
+ "nats": [ # A list of NAT services created in this router.
+ { # Represents a Nat resource. It enables the VMs within the specified
+ # subnetworks to access Internet without external IP addresses. It specifies
+ # a list of subnetworks (and the ranges within) that want to use NAT.
+ # Customers can also provide the external IPs that would be used for NAT. GCP
+ # would auto-allocate ephemeral IPs if no external IPs are provided.
+ "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses.
+ # Must be one of: PREMIUM, STANDARD.
+ # If not specified, then the current
+ # project-level default tier is used.
+ "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs
+ # must be valid static external IPs that have been assigned to the NAT.
+ # These IPs should be used for updating/patching a NAT only.
+ "A String",
+ ],
+ "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation.
+ #
+ #
+ # If not specified, it is disabled by default.
+ #
+ #
+ # If set to true,
+ #
+ # - Dynamic Port Allocation will be enabled on this NAT
+ # config.
+ # - enableEndpointIndependentMapping cannot be set to true.
+ # - If minPorts is set, minPortsPerVm must be set to a
+ # power of two greater than or equal to 32. If minPortsPerVm is not set, a
+ # minimum of 32 ports will be allocated to a VM from this NAT
+ # config.
+ "enableEndpointIndependentMapping": True or False,
+ "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
+ # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
+ "A String",
+ ],
+ "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
+ "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.
+ "enable": True or False, # Indicates whether or not to export logs. This is false by default.
+ "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified,
+ # logs are exported for all connections handled by this NAT.
+ # This option can take one of the following values:
+ #
+ # - ERRORS_ONLY: Export logs only for connection failures.
+ # - TRANSLATIONS_ONLY: Export logs only for successful
+ # connections.
+ # - ALL: Export logs for all connections, successful and
+ # unsuccessful.
+ },
+ "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when
+ # Dynamic Port Allocation is enabled.
+ #
+ #
+ # If Dynamic Port Allocation is not enabled, this field has no effect.
+ #
+ #
+ # If Dynamic Port Allocation is enabled, and this field is set, it must be
+ # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
+ # is not set.
+ #
+ #
+ # If Dynamic Port Allocation is enabled and this field is not set,
+ # a maximum of 65536 ports will be allocated to a VM from this NAT
+ # config.
+ "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not
+ # set, a default number of ports is allocated to a VM. This is rounded
+ # up to the nearest power of 2. For example, if the value of this field is
+ # 50, at least 64 ports are allocated to a VM.
+ "name": "A String", # Unique name of this Nat service.
+ # The name must be 1-63 characters long and comply withRFC1035.
+ "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64
+ # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
+ # selected for the SubnetworkIpRangeToNat64Option above.
+ { # Specifies a subnetwork to enable NAT64.
+ "name": "A String", # URL for the subnetwork resource that will use NAT64.
+ },
+ ],
+ "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following
+ # values:
+ #
+ # - MANUAL_ONLY: Uses only Nat IP addresses provided by
+ # customers. When there are not enough specified Nat IPs, the Nat service
+ # fails for new VMs.
+ # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
+ # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
+ # be empty.
+ "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP
+ # addresses must be valid static external IP addresses assigned to the
+ # project.
+ "A String",
],
"rules": [ # A list of rules associated with this NAT.
{
@@ -5764,124 +6364,74 @@ Method Details
patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)
- Patches Route Policy +patchNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)+Patches Named Set Args: project: string, Project ID for this request. (required) region: string, Name of the region for this request. (required) - router: string, Name of the Router resource where Route Policy is defined. (required) + router: string, Name of the Router resource where Named Set is defined. (required) body: object, The request body. The object takes the form of: { - "description": "A String", # An optional description of route policy. - "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is - # essentially a hash of the Route Policy used for optimistic locking. - # The fingerprint is initially generated by Compute Engine and changes - # after every request to modify or update Route Policy. You must always - # provide an up-to-date fingerprint hash in order to update or change - # labels. - # - # To see the latest fingerprint, make a getRoutePolicy() request - # to retrieve a Route Policy. - "name": "A String", # Route Policy name, which must be a resource ID segment and unique - # within all the router's Route Policies. Name should conform to RFC1035. - "terms": [ # List of terms (the order in the list is not important, they are evaluated - # in order of priority). Order of policies is not retained and might change - # when getting policy later. - { - "actions": [ # CEL expressions to evaluate to modify a route when this term matches. - { # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # - # Example (Comparison): - # - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # - # Example (Equality): - # - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # - # Example (Logic): - # - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # - # Example (Data Manipulation): - # - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. - "description": "A String", # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language - # syntax. - "location": "A String", # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing - # its purpose. This can be used e.g. in UIs which allow to enter the - # expression. - }, - ], - "match": { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term - # applies. When not set, the term applies to all - # routes. - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # - # Example (Comparison): - # - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # - # Example (Equality): - # - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # - # Example (Logic): - # - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # - # Example (Data Manipulation): - # - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. - "description": "A String", # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language - # syntax. - "location": "A String", # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing - # its purpose. This can be used e.g. in UIs which allow to enter the - # expression. - }, - "priority": 42, # The evaluation priority for this term, which must be between 0 - # (inclusive) and 2^31 (exclusive), and unique within the list. + "description": "A String", # An optional description of named set. + "elements": [ # CEL expressions that are comparable to constructs of this set's type + # (see Policy Language). + { # Represents a textual expression in the Common Expression Language (CEL) + # syntax. CEL is a C-like expression language. The syntax and semantics of CEL + # are documented at https://github.com/google/cel-spec. + # + # Example (Comparison): + # + # title: "Summary size limit" + # description: "Determines if a summary is less than 100 chars" + # expression: "document.summary.size() < 100" + # + # Example (Equality): + # + # title: "Requestor is owner" + # description: "Determines if requestor is the document owner" + # expression: "document.owner == request.auth.claims.email" + # + # Example (Logic): + # + # title: "Public documents" + # description: "Determine whether the document should be publicly visible" + # expression: "document.type != 'private' && document.type != 'internal'" + # + # Example (Data Manipulation): + # + # title: "Notification string" + # description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" + # + # The exact variables and functions that may be referenced within an expression + # are determined by the service that evaluates it. See the service + # documentation for additional information. + "description": "A String", # Optional. Description of the expression. This is a longer text which + # describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language + # syntax. + "location": "A String", # Optional. String indicating the location of the expression for error + # reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing + # its purpose. This can be used e.g. in UIs which allow to enter the + # expression. }, ], - "type": "A String", + "fingerprint": "A String", # A fingerprint for the Named Set being applied to this Router, which is + # essentially a hash of the Named Set used for optimistic locking. + # The fingerprint is initially generated by Compute Engine and changes + # after every request to modify or update the Named Set. You must always + # provide an up-to-date fingerprint hash in order to update or change + # labels. + # + # To see the latest fingerprint, make a getNamedSet() request + # to retrieve a Named Set. + "name": "A String", # This set's name, which must be a resource ID segment and unique within all + # named sets owned by the Router. Name should conform to RFC1035. + "type": "A String", # This named set's type } requestId: string, An optional request ID to identify requests. Specify a unique request ID so @@ -6158,528 +6708,139 @@Method Details
preview(project, region, router, body=None, x__xgafv=None)
- Preview fields auto-generated during router create andupdate operations. -Calling this method does NOT create or update the router. +patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)+Patches Route Policy Args: project: string, Project ID for this request. (required) region: string, Name of the region for this request. (required) - router: string, Name of the Router resource to query. (required) + router: string, Name of the Router resource where Route Policy is defined. (required) body: object, The request body. The object takes the form of: -{ # Represents a Cloud Router resource. - # - # For more information about Cloud Router, read theCloud - # Router overview. - "bgp": { # BGP information specific to this router. - "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. - # The options are DEFAULT or CUSTOM. - "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # is advertised to all peers of the router. - # These groups will be advertised in addition to any specified prefixes. - # Leave this field blank to advertise no custom groups. - "A String", - ], - "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # is advertised to all peers of the router. - # These IP ranges will be advertised in addition to any specified groups. - # Leave this field blank to advertise no custom IP ranges. - { # Description-tagged IP ranges for the router to advertise. - "description": "A String", # User-specified description for the IP range. - "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. - }, - ], - "asn": 42, # Local BGP Autonomous System Number (ASN). - # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The - # value will be fixed for this router resource. All VPN tunnels that link - # to this router will have the same local ASN. - "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It - # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at - # least /30, even if the BGP sessions are over IPv6. It must not overlap - # with any IPv4 BGP session ranges. - # - # - # Other vendors commonly call this "router ID". - "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are - # sent to the peer. - # - # - # Hold time is three times the interval at which keepalive messages are - # sent, and the hold time is the maximum number of seconds allowed to - # elapse between successive keepalive messages that BGP receives from a - # peer. - # - # - # BGP will use the smaller of either the local hold time value or the - # peer's hold time value as the hold time for the BGP connection between - # the two peers. - # - # - # If set, this value must be between 20 and 60. The default is 20. - }, - "bgpPeers": [ # BGP information that must be configured into the routing stack to - # establish BGP peering. This information must specify the peer ASN and - # either the interface name, IP address, or peer IP address. Please refer toRFC4273. +{ + "description": "A String", # An optional description of route policy. + "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is + # essentially a hash of the Route Policy used for optimistic locking. + # The fingerprint is initially generated by Compute Engine and changes + # after every request to modify or update Route Policy. You must always + # provide an up-to-date fingerprint hash in order to update or change + # labels. + # + # To see the latest fingerprint, make a getRoutePolicy() request + # to retrieve a Route Policy. + "name": "A String", # Route Policy name, which must be a resource ID segment and unique + # within all the router's Route Policies. Name should conform to RFC1035. + "terms": [ # List of terms (the order in the list is not important, they are evaluated + # in order of priority). Order of policies is not retained and might change + # when getting policy later. { - "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. - "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, - # which currently supports the following option: - # - # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This - # excludes any routes learned for subnets that use - # VPC Network Peering. - # - # - # Note that this field can only be populated if advertise_mode is CUSTOM - # and overrides the list defined for the router (in the "bgp" message). - # These groups are advertised in addition to any specified prefixes. - # Leave this field blank to advertise no custom groups. - "A String", - ], - "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # overrides the list defined for the router (in the "bgp" message). - # These IP ranges are advertised in addition to any specified groups. - # Leave this field blank to advertise no custom IP ranges. - { # Description-tagged IP ranges for the router to advertise. - "description": "A String", # User-specified description for the IP range. - "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. - }, - ], - "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more - # than one matching route of maximum length, the routes with the lowest - # priority value win. - "bfd": { # BFD configuration for the BGP peering. - "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets - # received from the peer router. The actual value is negotiated between - # the two routers and is equal to the greater of this value and the - # transmit interval of the other router. - # - # - # If set, this value must be between 1000 and 30000. - # - # - # The default is 1000. - "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets - # transmitted to the peer router. The actual value is negotiated between - # the two routers and is equal to the greater of this value and the - # corresponding receive interval of the other router. - # + "actions": [ # CEL expressions to evaluate to modify a route when this term matches. + { # Represents a textual expression in the Common Expression Language (CEL) + # syntax. CEL is a C-like expression language. The syntax and semantics of CEL + # are documented at https://github.com/google/cel-spec. # - # If set, this value must be between 1000 and 30000. + # Example (Comparison): # + # title: "Summary size limit" + # description: "Determines if a summary is less than 100 chars" + # expression: "document.summary.size() < 100" # - # The default is 1000. - "multiplier": 42, # The number of consecutive BFD packets that must be missed - # before BFD declares that a peer is unavailable. + # Example (Equality): # + # title: "Requestor is owner" + # description: "Determines if requestor is the document owner" + # expression: "document.owner == request.auth.claims.email" # - # If set, the value must be a value between 5 and 16. + # Example (Logic): # + # title: "Public documents" + # description: "Determine whether the document should be publicly visible" + # expression: "document.type != 'private' && document.type != 'internal'" # - # The default is 5. - "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. + # Example (Data Manipulation): # + # title: "Notification string" + # description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" # - # If set to ACTIVE, the Cloud Router will initiate the BFD session for - # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the - # peer router to initiate the BFD session for this BGP peer. If set to - # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. - }, - "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP - # session. - { - "range": "A String", # The custom learned route IP address range. Must be a valid - # CIDR-formatted prefix. If an IP address is provided without a subnet - # mask, it is interpreted as, for IPv4, a `/32` singular IP address - # range, and, for IPv6, `/128`. + # The exact variables and functions that may be referenced within an expression + # are determined by the service that evaluates it. See the service + # documentation for additional information. + "description": "A String", # Optional. Description of the expression. This is a longer text which + # describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language + # syntax. + "location": "A String", # Optional. String indicating the location of the expression for error + # reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing + # its purpose. This can be used e.g. in UIs which allow to enter the + # expression. }, ], - "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This - # value is applied to all custom learned route ranges for the session. - # You can choose a value from `0` to `65335`. If you don't provide a - # value, Google Cloud assigns a priority of `100` to the ranges. - "enable": "A String", # The status of the BGP peer connection. - # - # - # If set to FALSE, any active session with the peer is terminated and - # all associated routing information is removed. If set to TRUE, the - # peer connection can be established with routing information. The default - # is TRUE. - "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if - # the peerIpAddress is version 4. - "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the - # peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be - # evaluated. The name must correspond to an existing policy that has - # ROUTE_POLICY_TYPE_EXPORT type. - "A String", - ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be - # evaluated. The name must correspond to an existing policy that has - # ROUTE_POLICY_TYPE_IMPORT type. - "A String", - ], - "interfaceName": "A String", # Name of the interface the BGP peer is associated with. - "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. - "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. - "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. - "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. - # - # - MANAGED_BY_USER is the default value and can be managed by you - # or other users - # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed - # by Cloud Interconnect, specifically by an InterconnectAttachment of type - # PARTNER. Google automatically creates, updates, and deletes this type of - # BGP peer when the PARTNER InterconnectAttachment is created, updated, - # or deleted. - "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the - # name of one of the entries in the Router.md5_authentication_keys. The - # field must comply with RFC1035. - "name": "A String", # Name of this BGP peer. - # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 - # characters long and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - # lowercase letter, and all following characters must be a dash, lowercase - # letter, or digit, except the last character, which cannot be a dash. - "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use - # a different value. - "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. - "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. - "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. - "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router - # appliances such as Next Gen Firewalls, Virtual Routers, or Router - # Appliances. The VM instance must be located in zones contained in the - # same region as this Cloud Router. - # The VM instance is the peer side of the BGP session. - }, - ], - "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 - # text format. - "description": "A String", # An optional description of this resource. Provide this property when you - # create the resource. - "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN - # attachments (interconnectAttachments). - "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is - # defined by the server. - "interfaces": [ # Router interfaces. - # To create a BGP peer that uses a router interface, - # the interface must have one of the following fields specified: - # - # - linkedVpnTunnel - # - linkedInterconnectAttachment - # - subnetwork - # - # - # You can create a router interface without any of these fields specified. - # However, you cannot create a BGP peer that uses that interface. - { - "ipRange": "A String", # IP address and range of the interface. + "match": { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term + # applies. When not set, the term applies to all + # routes. + # syntax. CEL is a C-like expression language. The syntax and semantics of CEL + # are documented at https://github.com/google/cel-spec. # - # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must - # be a CIDR-formatted string, for example, 169.254.0.1/30. - # Note: Do not truncate the IP address, as it represents the IP address of - # the interface. - # - For Internet Protocol version 6 (IPv6), the value - # must be a unique local address (ULA) range from fdff:1::/64 - # with a mask length of 126 or less. This value should be a CIDR-formatted - # string, for example, fdff:1::1/112. Within the router's - # VPC, this IPv6 prefix will be reserved exclusively for this connection - # and cannot be used for any other purpose. - "ipVersion": "A String", # IP version of this interface. - "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region - # as the router. Each interface can have one linked resource, which can be - # a VPN tunnel, an Interconnect attachment, or a subnetwork. - "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the - # router. Each interface can have one linked resource, which can be - # a VPN tunnel, an Interconnect attachment, or a subnetwork. - "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. + # Example (Comparison): # - # - MANAGED_BY_USER is the default value and can be managed directly - # by users. - # - MANAGED_BY_ATTACHMENT is an interface that is configured and - # managed by Cloud Interconnect, specifically, by an InterconnectAttachment - # of type PARTNER. Google automatically creates, updates, and deletes - # this type of interface when the PARTNER InterconnectAttachment is - # created, updated, or deleted. - "name": "A String", # Name of this interface entry. - # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 - # characters long and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - # lowercase letter, and all following characters must be a dash, lowercase - # letter, or digit, except the last character, which cannot be a dash. - "privateIpAddress": "A String", # The regional private internal IP address that is used to establish - # BGP sessions to a VM instance acting as a third-party - # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or - # an SD-WAN VM. - "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface - # you are creating. The redundantInterface must belong to the same Cloud - # Router as the interface here. To establish the BGP session to a Router - # Appliance VM, you must create two BGP peers. The two BGP peers must be - # attached to two separate interfaces that are redundant with each other. - # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must - # be 1-63 characters long and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - # lowercase letter, and all following characters must be a dash, lowercase - # letter, or digit, except the last character, which cannot be a dash. - "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which - # must be in the same region as the Cloud Router. - # When you establish a BGP session to a VM instance using this interface, - # the VM instance must belong to the same subnetwork as the subnetwork - # specified here. - }, - ], - "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for - # routers. - "md5AuthenticationKeys": [ # Keys used for MD5 authentication. - { - "key": "A String", # [Input only] Value of the key. + # title: "Summary size limit" + # description: "Determines if a summary is less than 100 chars" + # expression: "document.summary.size() < 100" # - # For patch and update calls, it can be skipped to - # copy the value from the previous configuration. This is allowed if the - # key with the same name existed before the operation. Maximum length is 80 - # characters. Can only contain printable ASCII characters. - "name": "A String", # Name used to identify the key. + # Example (Equality): # - # Must be unique within a router. Must be referenced by exactly - # one bgpPeer. Must comply withRFC1035. - }, - ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. - # The name must be 1-63 characters long, and comply withRFC1035. - # Specifically, the name must be 1-63 characters long and match the regular - # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - # character must be a lowercase letter, and all following characters must - # be a dash, lowercase letter, or digit, except the last character, which - # cannot be a dash. - "nats": [ # A list of NAT services created in this router. - { # Represents a Nat resource. It enables the VMs within the specified - # subnetworks to access Internet without external IP addresses. It specifies - # a list of subnetworks (and the ranges within) that want to use NAT. - # Customers can also provide the external IPs that would be used for NAT. GCP - # would auto-allocate ephemeral IPs if no external IPs are provided. - "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses. - # Must be one of: PREMIUM, STANDARD. - # If not specified, then the current - # project-level default tier is used. - "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs - # must be valid static external IPs that have been assigned to the NAT. - # These IPs should be used for updating/patching a NAT only. - "A String", - ], - "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. + # title: "Requestor is owner" + # description: "Determines if requestor is the document owner" + # expression: "document.owner == request.auth.claims.email" # + # Example (Logic): # - # If not specified, it is disabled by default. + # title: "Public documents" + # description: "Determine whether the document should be publicly visible" + # expression: "document.type != 'private' && document.type != 'internal'" # + # Example (Data Manipulation): # - # If set to true, + # title: "Notification string" + # description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" # - # - Dynamic Port Allocation will be enabled on this NAT - # config. - # - enableEndpointIndependentMapping cannot be set to true. - # - If minPorts is set, minPortsPerVm must be set to a - # power of two greater than or equal to 32. If minPortsPerVm is not set, a - # minimum of 32 ports will be allocated to a VM from this NAT - # config. - "enableEndpointIndependentMapping": True or False, - "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list - # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM - "A String", - ], - "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. - "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. - "enable": True or False, # Indicates whether or not to export logs. This is false by default. - "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, - # logs are exported for all connections handled by this NAT. - # This option can take one of the following values: - # - # - ERRORS_ONLY: Export logs only for connection failures. - # - TRANSLATIONS_ONLY: Export logs only for successful - # connections. - # - ALL: Export logs for all connections, successful and - # unsuccessful. + # The exact variables and functions that may be referenced within an expression + # are determined by the service that evaluates it. See the service + # documentation for additional information. + "description": "A String", # Optional. Description of the expression. This is a longer text which + # describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language + # syntax. + "location": "A String", # Optional. String indicating the location of the expression for error + # reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing + # its purpose. This can be used e.g. in UIs which allow to enter the + # expression. }, - "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when - # Dynamic Port Allocation is enabled. - # - # - # If Dynamic Port Allocation is not enabled, this field has no effect. - # - # - # If Dynamic Port Allocation is enabled, and this field is set, it must be - # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm - # is not set. - # - # - # If Dynamic Port Allocation is enabled and this field is not set, - # a maximum of 65536 ports will be allocated to a VM from this NAT - # config. - "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not - # set, a default number of ports is allocated to a VM. This is rounded - # up to the nearest power of 2. For example, if the value of this field is - # 50, at least 64 ports are allocated to a VM. - "name": "A String", # Unique name of this Nat service. - # The name must be 1-63 characters long and comply withRFC1035. - "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64 - # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is - # selected for the SubnetworkIpRangeToNat64Option above. - { # Specifies a subnetwork to enable NAT64. - "name": "A String", # URL for the subnetwork resource that will use NAT64. - }, - ], - "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following - # values: - # - # - MANUAL_ONLY: Uses only Nat IP addresses provided by - # customers. When there are not enough specified Nat IPs, the Nat service - # fails for new VMs. - # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers - # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should - # be empty. - "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP - # addresses must be valid static external IP addresses assigned to the - # project. - "A String", - ], - "rules": [ # A list of rules associated with this NAT. - { - "action": { # The action to be enforced for traffic that matches this rule. - "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP - # addresses must be valid static external IP addresses assigned to the - # project. - # This field is used for public NAT. - "A String", - ], - "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this - # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. - # This field is used for private NAT. - "A String", - ], - "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs - # must be valid static external IPs that have been assigned to the NAT. - # These IPs should be used for updating/patching a NAT rule only. - # This field is used for public NAT. - "A String", - ], - "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be - # drained. This is only supported on patch/update, and these - # subnetworks must have previously been used as active ranges in this - # NAT Rule. - # This field is used for private NAT. - "A String", - ], - }, - "description": "A String", # An optional description of this rule. - "match": "A String", # CEL expression that specifies the match condition that egress traffic - # from a VM is evaluated against. If it evaluates to true, the - # corresponding `action` is enforced. - # - # The following examples are valid match expressions for public NAT: - # - # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, - # '2.2.0.0/16')` - # - # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` - # - # The following example is a valid match expression for private NAT: - # - # `nexthop.hub == - # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` - "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number - # must be a positive value between 0 and 65000, and - # must be unique among rules within a NAT. - }, - ], - "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: - # - # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every - # Subnetwork are allowed to Nat. - # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges - # in every Subnetwork are allowed to Nat. - # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat - # (specified in the field subnetwork below) - # - # - # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. - # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there - # should not be any other Router.Nat section in any Router for this network - # in this region. - "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following - # values: - # - # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in - # every Subnetwork are allowed to Nat. - # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat - # (specified in the field nat64_subnetwork below) - # - # - # The default is NAT64_OPTION_UNSPECIFIED. - # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other - # Router.Nat section in this region can also enable NAT64 for any - # Subnetworks in this network. Other Router.Nat sections can still be - # present to enable NAT44 only. - "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT - # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the - # SubnetworkIpRangeToNatOption above. - { # Defines the IP ranges that want to use NAT for a subnetwork. - "name": "A String", # URL for the subnetwork resource that will use NAT. - "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to - # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" - # is one of the values in source_ip_ranges_to_nat. - "A String", - ], - "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All - # options of a single value are valid except - # NAT_IP_RANGE_OPTION_UNSPECIFIED. - # The only valid option with multiple values is: ["PRIMARY_IP_RANGE", - # "LIST_OF_SECONDARY_IP_RANGES"] - # Default: [ALL_IP_RANGES] - "A String", - ], - }, - ], - "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s - # if not set. - "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. - # Defaults to 120s if not set. - "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if - # not set. - "type": "A String", # Indicates whether this NAT is used for public or private IP - # translation. If unspecified, it defaults to PUBLIC. - "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. + "priority": 42, # The evaluation priority for this term, which must be between 0 + # (inclusive) and 2^31 (exclusive), and unique within the list. }, ], - "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. - "network": "A String", # URI of the network to which this router belongs. - "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted - # as part of resource payload. - "resourceManagerTags": { # Tag keys/values directly bound to this resource. - # The field is allowed for INSERT - # only. The keys/values to set on the resource should be specified in - # either ID { : } or Namespaced format - # { : }. - # For example the following are valid inputs: - # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} - # * {"123/environment" : "production", "345/abc" : "xyz"} - # Note: - # * Invalid combinations of ID & namespaced format is not supported. For - # instance: {"123/environment" : "tagValues/444"} is invalid. - # * Inconsistent format is not supported. For instance: - # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. - "a_key": "A String", - }, - }, - "region": "A String", # [Output Only] URI of the region where the router resides. - # You must specify this field as part of the HTTP request URL. It is - # not settable as a field in the request body. - "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "type": "A String", } + requestId: string, An optional request ID to identify requests. Specify a unique request ID so +that if you must retry your request, the server will know to ignore the +request if it has already been completed. + +For example, consider a situation where you make an initial request and +the request times out. If you make the request again with the same +request ID, the server can check if original operation with the same +request ID was received, and if so, will ignore the second request. This +prevents clients from accidentally creating duplicate commitments. + +The request ID must be +a valid UUID with the exception that zero UUID is not supported +(00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -6688,688 +6849,390 @@+Method Details
Returns: An object of the form: - { - "resource": { # Represents a Cloud Router resource. # Preview of given router. - # - # For more information about Cloud Router, read theCloud - # Router overview. - "bgp": { # BGP information specific to this router. - "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. - # The options are DEFAULT or CUSTOM. - "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # is advertised to all peers of the router. - # These groups will be advertised in addition to any specified prefixes. - # Leave this field blank to advertise no custom groups. - "A String", - ], - "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # is advertised to all peers of the router. - # These IP ranges will be advertised in addition to any specified groups. - # Leave this field blank to advertise no custom IP ranges. - { # Description-tagged IP ranges for the router to advertise. - "description": "A String", # User-specified description for the IP range. - "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. - }, - ], - "asn": 42, # Local BGP Autonomous System Number (ASN). - # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The - # value will be fixed for this router resource. All VPN tunnels that link - # to this router will have the same local ASN. - "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It - # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at - # least /30, even if the BGP sessions are over IPv6. It must not overlap - # with any IPv4 BGP session ranges. - # - # - # Other vendors commonly call this "router ID". - "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are - # sent to the peer. - # - # - # Hold time is three times the interval at which keepalive messages are - # sent, and the hold time is the maximum number of seconds allowed to - # elapse between successive keepalive messages that BGP receives from a - # peer. - # - # - # BGP will use the smaller of either the local hold time value or the - # peer's hold time value as the hold time for the BGP connection between - # the two peers. - # - # - # If set, this value must be between 20 and 60. The default is 20. - }, - "bgpPeers": [ # BGP information that must be configured into the routing stack to - # establish BGP peering. This information must specify the peer ASN and - # either the interface name, IP address, or peer IP address. Please refer toRFC4273. - { - "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. - "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, - # which currently supports the following option: - # - # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This - # excludes any routes learned for subnets that use - # VPC Network Peering. - # - # - # Note that this field can only be populated if advertise_mode is CUSTOM - # and overrides the list defined for the router (in the "bgp" message). - # These groups are advertised in addition to any specified prefixes. - # Leave this field blank to advertise no custom groups. - "A String", - ], - "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # overrides the list defined for the router (in the "bgp" message). - # These IP ranges are advertised in addition to any specified groups. - # Leave this field blank to advertise no custom IP ranges. - { # Description-tagged IP ranges for the router to advertise. - "description": "A String", # User-specified description for the IP range. - "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. - }, - ], - "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more - # than one matching route of maximum length, the routes with the lowest - # priority value win. - "bfd": { # BFD configuration for the BGP peering. - "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets - # received from the peer router. The actual value is negotiated between - # the two routers and is equal to the greater of this value and the - # transmit interval of the other router. - # - # - # If set, this value must be between 1000 and 30000. - # - # - # The default is 1000. - "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets - # transmitted to the peer router. The actual value is negotiated between - # the two routers and is equal to the greater of this value and the - # corresponding receive interval of the other router. - # - # - # If set, this value must be between 1000 and 30000. - # - # - # The default is 1000. - "multiplier": 42, # The number of consecutive BFD packets that must be missed - # before BFD declares that a peer is unavailable. - # - # - # If set, the value must be a value between 5 and 16. - # - # - # The default is 5. - "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. - # - # - # If set to ACTIVE, the Cloud Router will initiate the BFD session for - # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the - # peer router to initiate the BFD session for this BGP peer. If set to - # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. - }, - "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP - # session. + { # Represents an Operation resource. + # + # Google Compute Engine has three Operation resources: + # + # * [Global](/compute/docs/reference/rest/beta/globalOperations) + # * [Regional](/compute/docs/reference/rest/beta/regionOperations) + # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) + # + # You can use an operation resource to manage asynchronous API requests. + # For more information, readHandling + # API responses. + # + # Operations can be global, regional or zonal. + # + # - For global operations, use the `globalOperations` + # resource. + # - For regional operations, use the + # `regionOperations` resource. + # - For zonal operations, use + # the `zoneOperations` resource. + # + # + # + # For more information, read + # Global, Regional, and Zonal Resources. + # + # Note that completed Operation resources have a limited + # retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. + # Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is + # set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 + # text format. + "error": { # [Output Only] If errors are generated during processing of the operation, + # this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. { - "range": "A String", # The custom learned route IP address range. Must be a valid - # CIDR-formatted prefix. If an IP address is provided without a subnet - # mask, it is interpreted as, for IPv4, a `/32` singular IP address - # range, and, for IPv6, `/128`. + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, }, ], - "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This - # value is applied to all custom learned route ranges for the session. - # You can choose a value from `0` to `65335`. If you don't provide a - # value, Google Cloud assigns a priority of `100` to the ranges. - "enable": "A String", # The status of the BGP peer connection. - # - # - # If set to FALSE, any active session with the peer is terminated and - # all associated routing information is removed. If set to TRUE, the - # peer connection can be established with routing information. The default - # is TRUE. - "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if - # the peerIpAddress is version 4. - "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the - # peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be - # evaluated. The name must correspond to an existing policy that has - # ROUTE_POLICY_TYPE_EXPORT type. - "A String", - ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be - # evaluated. The name must correspond to an existing policy that has - # ROUTE_POLICY_TYPE_IMPORT type. - "A String", - ], - "interfaceName": "A String", # Name of the interface the BGP peer is associated with. - "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. - "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. - "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. - "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. - # - # - MANAGED_BY_USER is the default value and can be managed by you - # or other users - # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed - # by Cloud Interconnect, specifically by an InterconnectAttachment of type - # PARTNER. Google automatically creates, updates, and deletes this type of - # BGP peer when the PARTNER InterconnectAttachment is created, updated, - # or deleted. - "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the - # name of one of the entries in the Router.md5_authentication_keys. The - # field must comply with RFC1035. - "name": "A String", # Name of this BGP peer. - # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 - # characters long and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - # lowercase letter, and all following characters must be a dash, lowercase - # letter, or digit, except the last character, which cannot be a dash. - "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use - # a different value. - "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. - "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. - "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. - "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router - # appliances such as Next Gen Firewalls, Virtual Routers, or Router - # Appliances. The VM instance must be located in zones contained in the - # same region as this Cloud Router. - # The VM instance is the peer side of the BGP session. + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. }, ], - "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 - # text format. - "description": "A String", # An optional description of this resource. Provide this property when you - # create the resource. - "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN - # attachments (interconnectAttachments). - "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is - # defined by the server. - "interfaces": [ # Router interfaces. - # To create a BGP peer that uses a router interface, - # the interface must have one of the following fields specified: - # - # - linkedVpnTunnel - # - linkedInterconnectAttachment - # - subnetwork - # - # - # You can create a router interface without any of these fields specified. - # However, you cannot create a BGP peer that uses that interface. - { - "ipRange": "A String", # IP address and range of the interface. - # - # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must - # be a CIDR-formatted string, for example, 169.254.0.1/30. - # Note: Do not truncate the IP address, as it represents the IP address of - # the interface. - # - For Internet Protocol version 6 (IPv6), the value - # must be a unique local address (ULA) range from fdff:1::/64 - # with a mask length of 126 or less. This value should be a CIDR-formatted - # string, for example, fdff:1::1/112. Within the router's - # VPC, this IPv6 prefix will be reserved exclusively for this connection - # and cannot be used for any other purpose. - "ipVersion": "A String", # IP version of this interface. - "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region - # as the router. Each interface can have one linked resource, which can be - # a VPN tunnel, an Interconnect attachment, or a subnetwork. - "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the - # router. Each interface can have one linked resource, which can be - # a VPN tunnel, an Interconnect attachment, or a subnetwork. - "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. + }, + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error + # message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error + # status code that was returned. For example, a `404` means the + # resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is + # defined by the server. + "insertTime": "A String", # [Output Only] The time that this operation was requested. + # This value is inRFC3339 + # text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an + # error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information + # if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. + }, + }, + }, + "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for + # Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a + # group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, + # `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. + # There is no requirement that this be linear or support any granularity of + # operations. This should not be used to guess when the operation will be + # complete. This number should monotonically increase as the operation + # progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only + # applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, + # this field will contain information on all underlying zonal actions and + # their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is + # populated. + # different programming environments, including REST APIs and RPC APIs. It is + # used by [gRPC](https://github.com/grpc). Each `Status` message contains + # three pieces of data: error code, error message, and error details. # - # - MANAGED_BY_USER is the default value and can be managed directly - # by users. - # - MANAGED_BY_ATTACHMENT is an interface that is configured and - # managed by Cloud Interconnect, specifically, by an InterconnectAttachment - # of type PARTNER. Google automatically creates, updates, and deletes - # this type of interface when the PARTNER InterconnectAttachment is - # created, updated, or deleted. - "name": "A String", # Name of this interface entry. - # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 - # characters long and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - # lowercase letter, and all following characters must be a dash, lowercase - # letter, or digit, except the last character, which cannot be a dash. - "privateIpAddress": "A String", # The regional private internal IP address that is used to establish - # BGP sessions to a VM instance acting as a third-party - # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or - # an SD-WAN VM. - "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface - # you are creating. The redundantInterface must belong to the same Cloud - # Router as the interface here. To establish the BGP session to a Router - # Appliance VM, you must create two BGP peers. The two BGP peers must be - # attached to two separate interfaces that are redundant with each other. - # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must - # be 1-63 characters long and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - # lowercase letter, and all following characters must be a dash, lowercase - # letter, or digit, except the last character, which cannot be a dash. - "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which - # must be in the same region as the Cloud Router. - # When you establish a BGP session to a VM instance using this interface, - # the VM instance must belong to the same subnetwork as the subnetwork - # specified here. + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + }, + "state": "A String", # [Output Only] Status of the action, which can be one of the following: + # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. }, + }, + }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. + # This value is inRFC3339 + # text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the + # following: + # `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the + # operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation + # of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For + # operations related to creating a snapshot, this points to the disk + # that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: + # `user@example.com` or + # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the + # operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, + ], + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only + # applicable when performing per-zone operations. +}
preview(project, region, router, body=None, x__xgafv=None)
+ Preview fields auto-generated during router create andupdate operations.
+Calling this method does NOT create or update the router.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to query. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Cloud Router resource.
+ #
+ # For more information about Cloud Router, read theCloud
+ # Router overview.
+ "bgp": { # BGP information specific to this router.
+ "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+ # The options are DEFAULT or CUSTOM.
+ "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # is advertised to all peers of the router.
+ # These groups will be advertised in addition to any specified prefixes.
+ # Leave this field blank to advertise no custom groups.
+ "A String",
],
- "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for
- # routers.
- "md5AuthenticationKeys": [ # Keys used for MD5 authentication.
- {
- "key": "A String", # [Input only] Value of the key.
- #
- # For patch and update calls, it can be skipped to
- # copy the value from the previous configuration. This is allowed if the
- # key with the same name existed before the operation. Maximum length is 80
- # characters. Can only contain printable ASCII characters.
- "name": "A String", # Name used to identify the key.
- #
- # Must be unique within a router. Must be referenced by exactly
- # one bgpPeer. Must comply withRFC1035.
+ "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # is advertised to all peers of the router.
+ # These IP ranges will be advertised in addition to any specified groups.
+ # Leave this field blank to advertise no custom IP ranges.
+ { # Description-tagged IP ranges for the router to advertise.
+ "description": "A String", # User-specified description for the IP range.
+ "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
},
],
- "name": "A String", # Name of the resource. Provided by the client when the resource is created.
- # The name must be 1-63 characters long, and comply withRFC1035.
- # Specifically, the name must be 1-63 characters long and match the regular
- # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
- # character must be a lowercase letter, and all following characters must
- # be a dash, lowercase letter, or digit, except the last character, which
- # cannot be a dash.
- "nats": [ # A list of NAT services created in this router.
- { # Represents a Nat resource. It enables the VMs within the specified
- # subnetworks to access Internet without external IP addresses. It specifies
- # a list of subnetworks (and the ranges within) that want to use NAT.
- # Customers can also provide the external IPs that would be used for NAT. GCP
- # would auto-allocate ephemeral IPs if no external IPs are provided.
- "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses.
- # Must be one of: PREMIUM, STANDARD.
- # If not specified, then the current
- # project-level default tier is used.
- "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs
- # must be valid static external IPs that have been assigned to the NAT.
- # These IPs should be used for updating/patching a NAT only.
- "A String",
- ],
- "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation.
- #
- #
- # If not specified, it is disabled by default.
- #
- #
- # If set to true,
- #
- # - Dynamic Port Allocation will be enabled on this NAT
- # config.
- # - enableEndpointIndependentMapping cannot be set to true.
- # - If minPorts is set, minPortsPerVm must be set to a
- # power of two greater than or equal to 32. If minPortsPerVm is not set, a
- # minimum of 32 ports will be allocated to a VM from this NAT
- # config.
- "enableEndpointIndependentMapping": True or False,
- "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
- # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
- "A String",
- ],
- "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
- "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.
- "enable": True or False, # Indicates whether or not to export logs. This is false by default.
- "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified,
- # logs are exported for all connections handled by this NAT.
- # This option can take one of the following values:
- #
- # - ERRORS_ONLY: Export logs only for connection failures.
- # - TRANSLATIONS_ONLY: Export logs only for successful
- # connections.
- # - ALL: Export logs for all connections, successful and
- # unsuccessful.
+ "asn": 42, # Local BGP Autonomous System Number (ASN).
+ # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
+ # value will be fixed for this router resource. All VPN tunnels that link
+ # to this router will have the same local ASN.
+ "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It
+ # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
+ # least /30, even if the BGP sessions are over IPv6. It must not overlap
+ # with any IPv4 BGP session ranges.
+ #
+ #
+ # Other vendors commonly call this "router ID".
+ "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are
+ # sent to the peer.
+ #
+ #
+ # Hold time is three times the interval at which keepalive messages are
+ # sent, and the hold time is the maximum number of seconds allowed to
+ # elapse between successive keepalive messages that BGP receives from a
+ # peer.
+ #
+ #
+ # BGP will use the smaller of either the local hold time value or the
+ # peer's hold time value as the hold time for the BGP connection between
+ # the two peers.
+ #
+ #
+ # If set, this value must be between 20 and 60. The default is 20.
+ },
+ "bgpPeers": [ # BGP information that must be configured into the routing stack to
+ # establish BGP peering. This information must specify the peer ASN and
+ # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
+ {
+ "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+ "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode,
+ # which currently supports the following option:
+ #
+ # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This
+ # excludes any routes learned for subnets that use
+ # VPC Network Peering.
+ #
+ #
+ # Note that this field can only be populated if advertise_mode is CUSTOM
+ # and overrides the list defined for the router (in the "bgp" message).
+ # These groups are advertised in addition to any specified prefixes.
+ # Leave this field blank to advertise no custom groups.
+ "A String",
+ ],
+ "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # overrides the list defined for the router (in the "bgp" message).
+ # These IP ranges are advertised in addition to any specified groups.
+ # Leave this field blank to advertise no custom IP ranges.
+ { # Description-tagged IP ranges for the router to advertise.
+ "description": "A String", # User-specified description for the IP range.
+ "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
},
- "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when
- # Dynamic Port Allocation is enabled.
+ ],
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more
+ # than one matching route of maximum length, the routes with the lowest
+ # priority value win.
+ "bfd": { # BFD configuration for the BGP peering.
+ "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+ # received from the peer router. The actual value is negotiated between
+ # the two routers and is equal to the greater of this value and the
+ # transmit interval of the other router.
#
#
- # If Dynamic Port Allocation is not enabled, this field has no effect.
+ # If set, this value must be between 1000 and 30000.
#
#
- # If Dynamic Port Allocation is enabled, and this field is set, it must be
- # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
- # is not set.
+ # The default is 1000.
+ "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+ # transmitted to the peer router. The actual value is negotiated between
+ # the two routers and is equal to the greater of this value and the
+ # corresponding receive interval of the other router.
#
#
- # If Dynamic Port Allocation is enabled and this field is not set,
- # a maximum of 65536 ports will be allocated to a VM from this NAT
- # config.
- "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not
- # set, a default number of ports is allocated to a VM. This is rounded
- # up to the nearest power of 2. For example, if the value of this field is
- # 50, at least 64 ports are allocated to a VM.
- "name": "A String", # Unique name of this Nat service.
- # The name must be 1-63 characters long and comply withRFC1035.
- "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64
- # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
- # selected for the SubnetworkIpRangeToNat64Option above.
- { # Specifies a subnetwork to enable NAT64.
- "name": "A String", # URL for the subnetwork resource that will use NAT64.
- },
- ],
- "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following
- # values:
+ # If set, this value must be between 1000 and 30000.
#
- # - MANUAL_ONLY: Uses only Nat IP addresses provided by
- # customers. When there are not enough specified Nat IPs, the Nat service
- # fails for new VMs.
- # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
- # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
- # be empty.
- "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP
- # addresses must be valid static external IP addresses assigned to the
- # project.
- "A String",
- ],
- "rules": [ # A list of rules associated with this NAT.
- {
- "action": { # The action to be enforced for traffic that matches this rule.
- "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP
- # addresses must be valid static external IP addresses assigned to the
- # project.
- # This field is used for public NAT.
- "A String",
- ],
- "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this
- # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
- # This field is used for private NAT.
- "A String",
- ],
- "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs
- # must be valid static external IPs that have been assigned to the NAT.
- # These IPs should be used for updating/patching a NAT rule only.
- # This field is used for public NAT.
- "A String",
- ],
- "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be
- # drained. This is only supported on patch/update, and these
- # subnetworks must have previously been used as active ranges in this
- # NAT Rule.
- # This field is used for private NAT.
- "A String",
- ],
- },
- "description": "A String", # An optional description of this rule.
- "match": "A String", # CEL expression that specifies the match condition that egress traffic
- # from a VM is evaluated against. If it evaluates to true, the
- # corresponding `action` is enforced.
- #
- # The following examples are valid match expressions for public NAT:
- #
- # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip,
- # '2.2.0.0/16')`
- #
- # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'`
- #
- # The following example is a valid match expression for private NAT:
- #
- # `nexthop.hub ==
- # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'`
- "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number
- # must be a positive value between 0 and 65000, and
- # must be unique among rules within a NAT.
- },
- ],
- "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:
#
- # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
- # Subnetwork are allowed to Nat.
- # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
- # in every Subnetwork are allowed to Nat.
- # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
- # (specified in the field subnetwork below)
+ # The default is 1000.
+ "multiplier": 42, # The number of consecutive BFD packets that must be missed
+ # before BFD declares that a peer is unavailable.
#
#
- # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
- # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
- # should not be any other Router.Nat section in any Router for this network
- # in this region.
- "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following
- # values:
+ # If set, the value must be a value between 5 and 16.
#
- # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
- # every Subnetwork are allowed to Nat.
- # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
- # (specified in the field nat64_subnetwork below)
#
+ # The default is 5.
+ "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.
#
- # The default is NAT64_OPTION_UNSPECIFIED.
- # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
- # Router.Nat section in this region can also enable NAT64 for any
- # Subnetworks in this network. Other Router.Nat sections can still be
- # present to enable NAT44 only.
- "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT
- # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
- # SubnetworkIpRangeToNatOption above.
- { # Defines the IP ranges that want to use NAT for a subnetwork.
- "name": "A String", # URL for the subnetwork resource that will use NAT.
- "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to
- # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES"
- # is one of the values in source_ip_ranges_to_nat.
- "A String",
- ],
- "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All
- # options of a single value are valid except
- # NAT_IP_RANGE_OPTION_UNSPECIFIED.
- # The only valid option with multiple values is: ["PRIMARY_IP_RANGE",
- # "LIST_OF_SECONDARY_IP_RANGES"]
- # Default: [ALL_IP_RANGES]
- "A String",
- ],
- },
- ],
- "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
- # if not set.
- "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
- # Defaults to 120s if not set.
- "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
- # not set.
- "type": "A String", # Indicates whether this NAT is used for public or private IP
- # translation. If unspecified, it defaults to PUBLIC.
- "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
- },
- ],
- "nccGateway": "A String", # URI of the ncc_gateway to which this router associated.
- "network": "A String", # URI of the network to which this router belongs.
- "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
- # as part of resource payload.
- "resourceManagerTags": { # Tag keys/values directly bound to this resource.
- # The field is allowed for INSERT
- # only. The keys/values to set on the resource should be specified in
- # either ID { : } or Namespaced format
- # { : }.
- # For example the following are valid inputs:
- # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
- # * {"123/environment" : "production", "345/abc" : "xyz"}
- # Note:
- # * Invalid combinations of ID & namespaced format is not supported. For
- # instance: {"123/environment" : "tagValues/444"} is invalid.
- # * Inconsistent format is not supported. For instance:
- # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
- "a_key": "A String",
- },
- },
- "region": "A String", # [Output Only] URI of the region where the router resides.
- # You must specify this field as part of the HTTP request URL. It is
- # not settable as a field in the request body.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
- },
-}
-testIamPermissions(project, region, resource, body=None, x__xgafv=None)
- Returns permissions that a caller has on the specified resource.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, The name of the region for this request. (required)
- resource: string, Name or id of the resource for this request. (required)
- body: object, The request body.
- The object takes the form of:
-
-{
- "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
- # wildcards (such as '*' or 'storage.*') are not allowed.
- "A String",
- ],
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
- # allowed.
- "A String",
- ],
-}
-update(project, region, router, body=None, requestId=None, x__xgafv=None)
- Updates the specified Router resource with the data included in the
-request. This method conforms toPUT semantics, which requests that the state of the
-target resource be created or replaced with the state defined by the
-representation enclosed in the request message payload.
-
-Args:
- project: string, Project ID for this request. (required)
- region: string, Name of the region for this request. (required)
- router: string, Name of the Router resource to update. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Represents a Cloud Router resource.
- #
- # For more information about Cloud Router, read theCloud
- # Router overview.
- "bgp": { # BGP information specific to this router.
- "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
- # The options are DEFAULT or CUSTOM.
- "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode.
- # This field can only be populated if advertise_mode is CUSTOM and
- # is advertised to all peers of the router.
- # These groups will be advertised in addition to any specified prefixes.
- # Leave this field blank to advertise no custom groups.
- "A String",
- ],
- "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
- # This field can only be populated if advertise_mode is CUSTOM and
- # is advertised to all peers of the router.
- # These IP ranges will be advertised in addition to any specified groups.
- # Leave this field blank to advertise no custom IP ranges.
- { # Description-tagged IP ranges for the router to advertise.
- "description": "A String", # User-specified description for the IP range.
- "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
- },
- ],
- "asn": 42, # Local BGP Autonomous System Number (ASN).
- # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
- # value will be fixed for this router resource. All VPN tunnels that link
- # to this router will have the same local ASN.
- "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It
- # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
- # least /30, even if the BGP sessions are over IPv6. It must not overlap
- # with any IPv4 BGP session ranges.
- #
- #
- # Other vendors commonly call this "router ID".
- "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are
- # sent to the peer.
- #
- #
- # Hold time is three times the interval at which keepalive messages are
- # sent, and the hold time is the maximum number of seconds allowed to
- # elapse between successive keepalive messages that BGP receives from a
- # peer.
- #
- #
- # BGP will use the smaller of either the local hold time value or the
- # peer's hold time value as the hold time for the BGP connection between
- # the two peers.
- #
- #
- # If set, this value must be between 20 and 60. The default is 20.
- },
- "bgpPeers": [ # BGP information that must be configured into the routing stack to
- # establish BGP peering. This information must specify the peer ASN and
- # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
- {
- "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
- "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode,
- # which currently supports the following option:
- #
- # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This
- # excludes any routes learned for subnets that use
- # VPC Network Peering.
- #
- #
- # Note that this field can only be populated if advertise_mode is CUSTOM
- # and overrides the list defined for the router (in the "bgp" message).
- # These groups are advertised in addition to any specified prefixes.
- # Leave this field blank to advertise no custom groups.
- "A String",
- ],
- "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
- # This field can only be populated if advertise_mode is CUSTOM and
- # overrides the list defined for the router (in the "bgp" message).
- # These IP ranges are advertised in addition to any specified groups.
- # Leave this field blank to advertise no custom IP ranges.
- { # Description-tagged IP ranges for the router to advertise.
- "description": "A String", # User-specified description for the IP range.
- "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
- },
- ],
- "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more
- # than one matching route of maximum length, the routes with the lowest
- # priority value win.
- "bfd": { # BFD configuration for the BGP peering.
- "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
- # received from the peer router. The actual value is negotiated between
- # the two routers and is equal to the greater of this value and the
- # transmit interval of the other router.
- #
- #
- # If set, this value must be between 1000 and 30000.
- #
- #
- # The default is 1000.
- "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
- # transmitted to the peer router. The actual value is negotiated between
- # the two routers and is equal to the greater of this value and the
- # corresponding receive interval of the other router.
- #
- #
- # If set, this value must be between 1000 and 30000.
- #
- #
- # The default is 1000.
- "multiplier": 42, # The number of consecutive BFD packets that must be missed
- # before BFD declares that a peer is unavailable.
- #
- #
- # If set, the value must be a value between 5 and 16.
- #
- #
- # The default is 5.
- "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.
- #
- #
- # If set to ACTIVE, the Cloud Router will initiate the BFD session for
- # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
- # peer router to initiate the BFD session for this BGP peer. If set to
- # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
+ #
+ # If set to ACTIVE, the Cloud Router will initiate the BFD session for
+ # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
+ # peer router to initiate the BFD session for this BGP peer. If set to
+ # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
},
"customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP
# session.
@@ -7579,186 +7442,1611 @@ Method Details
# logs are exported for all connections handled by this NAT.
# This option can take one of the following values:
#
- # - ERRORS_ONLY: Export logs only for connection failures.
- # - TRANSLATIONS_ONLY: Export logs only for successful
- # connections.
- # - ALL: Export logs for all connections, successful and
- # unsuccessful.
- },
- "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when
- # Dynamic Port Allocation is enabled.
- #
- #
- # If Dynamic Port Allocation is not enabled, this field has no effect.
- #
- #
- # If Dynamic Port Allocation is enabled, and this field is set, it must be
- # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
- # is not set.
- #
- #
- # If Dynamic Port Allocation is enabled and this field is not set,
- # a maximum of 65536 ports will be allocated to a VM from this NAT
- # config.
- "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not
- # set, a default number of ports is allocated to a VM. This is rounded
- # up to the nearest power of 2. For example, if the value of this field is
- # 50, at least 64 ports are allocated to a VM.
- "name": "A String", # Unique name of this Nat service.
- # The name must be 1-63 characters long and comply withRFC1035.
- "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64
- # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
- # selected for the SubnetworkIpRangeToNat64Option above.
- { # Specifies a subnetwork to enable NAT64.
- "name": "A String", # URL for the subnetwork resource that will use NAT64.
+ # - ERRORS_ONLY: Export logs only for connection failures.
+ # - TRANSLATIONS_ONLY: Export logs only for successful
+ # connections.
+ # - ALL: Export logs for all connections, successful and
+ # unsuccessful.
+ },
+ "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when
+ # Dynamic Port Allocation is enabled.
+ #
+ #
+ # If Dynamic Port Allocation is not enabled, this field has no effect.
+ #
+ #
+ # If Dynamic Port Allocation is enabled, and this field is set, it must be
+ # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
+ # is not set.
+ #
+ #
+ # If Dynamic Port Allocation is enabled and this field is not set,
+ # a maximum of 65536 ports will be allocated to a VM from this NAT
+ # config.
+ "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not
+ # set, a default number of ports is allocated to a VM. This is rounded
+ # up to the nearest power of 2. For example, if the value of this field is
+ # 50, at least 64 ports are allocated to a VM.
+ "name": "A String", # Unique name of this Nat service.
+ # The name must be 1-63 characters long and comply withRFC1035.
+ "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64
+ # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
+ # selected for the SubnetworkIpRangeToNat64Option above.
+ { # Specifies a subnetwork to enable NAT64.
+ "name": "A String", # URL for the subnetwork resource that will use NAT64.
+ },
+ ],
+ "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following
+ # values:
+ #
+ # - MANUAL_ONLY: Uses only Nat IP addresses provided by
+ # customers. When there are not enough specified Nat IPs, the Nat service
+ # fails for new VMs.
+ # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
+ # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
+ # be empty.
+ "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP
+ # addresses must be valid static external IP addresses assigned to the
+ # project.
+ "A String",
+ ],
+ "rules": [ # A list of rules associated with this NAT.
+ {
+ "action": { # The action to be enforced for traffic that matches this rule.
+ "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP
+ # addresses must be valid static external IP addresses assigned to the
+ # project.
+ # This field is used for public NAT.
+ "A String",
+ ],
+ "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this
+ # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
+ # This field is used for private NAT.
+ "A String",
+ ],
+ "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs
+ # must be valid static external IPs that have been assigned to the NAT.
+ # These IPs should be used for updating/patching a NAT rule only.
+ # This field is used for public NAT.
+ "A String",
+ ],
+ "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be
+ # drained. This is only supported on patch/update, and these
+ # subnetworks must have previously been used as active ranges in this
+ # NAT Rule.
+ # This field is used for private NAT.
+ "A String",
+ ],
+ },
+ "description": "A String", # An optional description of this rule.
+ "match": "A String", # CEL expression that specifies the match condition that egress traffic
+ # from a VM is evaluated against. If it evaluates to true, the
+ # corresponding `action` is enforced.
+ #
+ # The following examples are valid match expressions for public NAT:
+ #
+ # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip,
+ # '2.2.0.0/16')`
+ #
+ # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'`
+ #
+ # The following example is a valid match expression for private NAT:
+ #
+ # `nexthop.hub ==
+ # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'`
+ "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number
+ # must be a positive value between 0 and 65000, and
+ # must be unique among rules within a NAT.
+ },
+ ],
+ "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:
+ #
+ # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
+ # Subnetwork are allowed to Nat.
+ # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
+ # in every Subnetwork are allowed to Nat.
+ # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
+ # (specified in the field subnetwork below)
+ #
+ #
+ # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
+ # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
+ # should not be any other Router.Nat section in any Router for this network
+ # in this region.
+ "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following
+ # values:
+ #
+ # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
+ # every Subnetwork are allowed to Nat.
+ # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
+ # (specified in the field nat64_subnetwork below)
+ #
+ #
+ # The default is NAT64_OPTION_UNSPECIFIED.
+ # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
+ # Router.Nat section in this region can also enable NAT64 for any
+ # Subnetworks in this network. Other Router.Nat sections can still be
+ # present to enable NAT44 only.
+ "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT
+ # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
+ # SubnetworkIpRangeToNatOption above.
+ { # Defines the IP ranges that want to use NAT for a subnetwork.
+ "name": "A String", # URL for the subnetwork resource that will use NAT.
+ "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to
+ # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES"
+ # is one of the values in source_ip_ranges_to_nat.
+ "A String",
+ ],
+ "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All
+ # options of a single value are valid except
+ # NAT_IP_RANGE_OPTION_UNSPECIFIED.
+ # The only valid option with multiple values is: ["PRIMARY_IP_RANGE",
+ # "LIST_OF_SECONDARY_IP_RANGES"]
+ # Default: [ALL_IP_RANGES]
+ "A String",
+ ],
+ },
+ ],
+ "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
+ # if not set.
+ "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
+ # Defaults to 120s if not set.
+ "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
+ # not set.
+ "type": "A String", # Indicates whether this NAT is used for public or private IP
+ # translation. If unspecified, it defaults to PUBLIC.
+ "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
+ },
+ ],
+ "nccGateway": "A String", # URI of the ncc_gateway to which this router associated.
+ "network": "A String", # URI of the network to which this router belongs.
+ "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+ # The field is allowed for INSERT
+ # only. The keys/values to set on the resource should be specified in
+ # either ID { : } or Namespaced format
+ # { : }.
+ # For example the following are valid inputs:
+ # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+ # * {"123/environment" : "production", "345/abc" : "xyz"}
+ # Note:
+ # * Invalid combinations of ID & namespaced format is not supported. For
+ # instance: {"123/environment" : "tagValues/444"} is invalid.
+ # * Inconsistent format is not supported. For instance:
+ # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+ "a_key": "A String",
+ },
+ },
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ # You must specify this field as part of the HTTP request URL. It is
+ # not settable as a field in the request body.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "resource": { # Represents a Cloud Router resource. # Preview of given router.
+ #
+ # For more information about Cloud Router, read theCloud
+ # Router overview.
+ "bgp": { # BGP information specific to this router.
+ "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+ # The options are DEFAULT or CUSTOM.
+ "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # is advertised to all peers of the router.
+ # These groups will be advertised in addition to any specified prefixes.
+ # Leave this field blank to advertise no custom groups.
+ "A String",
+ ],
+ "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # is advertised to all peers of the router.
+ # These IP ranges will be advertised in addition to any specified groups.
+ # Leave this field blank to advertise no custom IP ranges.
+ { # Description-tagged IP ranges for the router to advertise.
+ "description": "A String", # User-specified description for the IP range.
+ "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+ },
+ ],
+ "asn": 42, # Local BGP Autonomous System Number (ASN).
+ # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
+ # value will be fixed for this router resource. All VPN tunnels that link
+ # to this router will have the same local ASN.
+ "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It
+ # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
+ # least /30, even if the BGP sessions are over IPv6. It must not overlap
+ # with any IPv4 BGP session ranges.
+ #
+ #
+ # Other vendors commonly call this "router ID".
+ "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are
+ # sent to the peer.
+ #
+ #
+ # Hold time is three times the interval at which keepalive messages are
+ # sent, and the hold time is the maximum number of seconds allowed to
+ # elapse between successive keepalive messages that BGP receives from a
+ # peer.
+ #
+ #
+ # BGP will use the smaller of either the local hold time value or the
+ # peer's hold time value as the hold time for the BGP connection between
+ # the two peers.
+ #
+ #
+ # If set, this value must be between 20 and 60. The default is 20.
+ },
+ "bgpPeers": [ # BGP information that must be configured into the routing stack to
+ # establish BGP peering. This information must specify the peer ASN and
+ # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
+ {
+ "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+ "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode,
+ # which currently supports the following option:
+ #
+ # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This
+ # excludes any routes learned for subnets that use
+ # VPC Network Peering.
+ #
+ #
+ # Note that this field can only be populated if advertise_mode is CUSTOM
+ # and overrides the list defined for the router (in the "bgp" message).
+ # These groups are advertised in addition to any specified prefixes.
+ # Leave this field blank to advertise no custom groups.
+ "A String",
+ ],
+ "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # overrides the list defined for the router (in the "bgp" message).
+ # These IP ranges are advertised in addition to any specified groups.
+ # Leave this field blank to advertise no custom IP ranges.
+ { # Description-tagged IP ranges for the router to advertise.
+ "description": "A String", # User-specified description for the IP range.
+ "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+ },
+ ],
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more
+ # than one matching route of maximum length, the routes with the lowest
+ # priority value win.
+ "bfd": { # BFD configuration for the BGP peering.
+ "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+ # received from the peer router. The actual value is negotiated between
+ # the two routers and is equal to the greater of this value and the
+ # transmit interval of the other router.
+ #
+ #
+ # If set, this value must be between 1000 and 30000.
+ #
+ #
+ # The default is 1000.
+ "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+ # transmitted to the peer router. The actual value is negotiated between
+ # the two routers and is equal to the greater of this value and the
+ # corresponding receive interval of the other router.
+ #
+ #
+ # If set, this value must be between 1000 and 30000.
+ #
+ #
+ # The default is 1000.
+ "multiplier": 42, # The number of consecutive BFD packets that must be missed
+ # before BFD declares that a peer is unavailable.
+ #
+ #
+ # If set, the value must be a value between 5 and 16.
+ #
+ #
+ # The default is 5.
+ "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.
+ #
+ #
+ # If set to ACTIVE, the Cloud Router will initiate the BFD session for
+ # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
+ # peer router to initiate the BFD session for this BGP peer. If set to
+ # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
+ },
+ "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP
+ # session.
+ {
+ "range": "A String", # The custom learned route IP address range. Must be a valid
+ # CIDR-formatted prefix. If an IP address is provided without a subnet
+ # mask, it is interpreted as, for IPv4, a `/32` singular IP address
+ # range, and, for IPv6, `/128`.
+ },
+ ],
+ "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This
+ # value is applied to all custom learned route ranges for the session.
+ # You can choose a value from `0` to `65335`. If you don't provide a
+ # value, Google Cloud assigns a priority of `100` to the ranges.
+ "enable": "A String", # The status of the BGP peer connection.
+ #
+ #
+ # If set to FALSE, any active session with the peer is terminated and
+ # all associated routing information is removed. If set to TRUE, the
+ # peer connection can be established with routing information. The default
+ # is TRUE.
+ "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
+ # the peerIpAddress is version 4.
+ "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
+ # peerIpAddress is version 6.
+ "exportPolicies": [ # List of export policies applied to this peer, in the order they must be
+ # evaluated. The name must correspond to an existing policy that has
+ # ROUTE_POLICY_TYPE_EXPORT type.
+ "A String",
+ ],
+ "importPolicies": [ # List of import policies applied to this peer, in the order they must be
+ # evaluated. The name must correspond to an existing policy that has
+ # ROUTE_POLICY_TYPE_IMPORT type.
+ "A String",
+ ],
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
+ "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
+ "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer.
+ #
+ # - MANAGED_BY_USER is the default value and can be managed by you
+ # or other users
+ # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
+ # by Cloud Interconnect, specifically by an InterconnectAttachment of type
+ # PARTNER. Google automatically creates, updates, and deletes this type of
+ # BGP peer when the PARTNER InterconnectAttachment is created, updated,
+ # or deleted.
+ "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the
+ # name of one of the entries in the Router.md5_authentication_keys. The
+ # field must comply with RFC1035.
+ "name": "A String", # Name of this BGP peer.
+ # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
+ # characters long and match the regular expression
+ # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+ # lowercase letter, and all following characters must be a dash, lowercase
+ # letter, or digit, except the last character, which cannot be a dash.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
+ # a different value.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform.
+ "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform.
+ "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform.
+ "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router
+ # appliances such as Next Gen Firewalls, Virtual Routers, or Router
+ # Appliances. The VM instance must be located in zones contained in the
+ # same region as this Cloud Router.
+ # The VM instance is the peer side of the BGP session.
+ },
+ ],
+ "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+ # text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you
+ # create the resource.
+ "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN
+ # attachments (interconnectAttachments).
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+ # defined by the server.
+ "interfaces": [ # Router interfaces.
+ # To create a BGP peer that uses a router interface,
+ # the interface must have one of the following fields specified:
+ #
+ # - linkedVpnTunnel
+ # - linkedInterconnectAttachment
+ # - subnetwork
+ #
+ #
+ # You can create a router interface without any of these fields specified.
+ # However, you cannot create a BGP peer that uses that interface.
+ {
+ "ipRange": "A String", # IP address and range of the interface.
+ #
+ # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
+ # be a CIDR-formatted string, for example, 169.254.0.1/30.
+ # Note: Do not truncate the IP address, as it represents the IP address of
+ # the interface.
+ # - For Internet Protocol version 6 (IPv6), the value
+ # must be a unique local address (ULA) range from fdff:1::/64
+ # with a mask length of 126 or less. This value should be a CIDR-formatted
+ # string, for example, fdff:1::1/112. Within the router's
+ # VPC, this IPv6 prefix will be reserved exclusively for this connection
+ # and cannot be used for any other purpose.
+ "ipVersion": "A String", # IP version of this interface.
+ "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region
+ # as the router. Each interface can have one linked resource, which can be
+ # a VPN tunnel, an Interconnect attachment, or a subnetwork.
+ "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the
+ # router. Each interface can have one linked resource, which can be
+ # a VPN tunnel, an Interconnect attachment, or a subnetwork.
+ "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface.
+ #
+ # - MANAGED_BY_USER is the default value and can be managed directly
+ # by users.
+ # - MANAGED_BY_ATTACHMENT is an interface that is configured and
+ # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
+ # of type PARTNER. Google automatically creates, updates, and deletes
+ # this type of interface when the PARTNER InterconnectAttachment is
+ # created, updated, or deleted.
+ "name": "A String", # Name of this interface entry.
+ # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
+ # characters long and match the regular expression
+ # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+ # lowercase letter, and all following characters must be a dash, lowercase
+ # letter, or digit, except the last character, which cannot be a dash.
+ "privateIpAddress": "A String", # The regional private internal IP address that is used to establish
+ # BGP sessions to a VM instance acting as a third-party
+ # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
+ # an SD-WAN VM.
+ "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface
+ # you are creating. The redundantInterface must belong to the same Cloud
+ # Router as the interface here. To establish the BGP session to a Router
+ # Appliance VM, you must create two BGP peers. The two BGP peers must be
+ # attached to two separate interfaces that are redundant with each other.
+ # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
+ # be 1-63 characters long and match the regular expression
+ # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+ # lowercase letter, and all following characters must be a dash, lowercase
+ # letter, or digit, except the last character, which cannot be a dash.
+ "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which
+ # must be in the same region as the Cloud Router.
+ # When you establish a BGP session to a VM instance using this interface,
+ # the VM instance must belong to the same subnetwork as the subnetwork
+ # specified here.
+ },
+ ],
+ "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for
+ # routers.
+ "md5AuthenticationKeys": [ # Keys used for MD5 authentication.
+ {
+ "key": "A String", # [Input only] Value of the key.
+ #
+ # For patch and update calls, it can be skipped to
+ # copy the value from the previous configuration. This is allowed if the
+ # key with the same name existed before the operation. Maximum length is 80
+ # characters. Can only contain printable ASCII characters.
+ "name": "A String", # Name used to identify the key.
+ #
+ # Must be unique within a router. Must be referenced by exactly
+ # one bgpPeer. Must comply withRFC1035.
+ },
+ ],
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+ # The name must be 1-63 characters long, and comply withRFC1035.
+ # Specifically, the name must be 1-63 characters long and match the regular
+ # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+ # character must be a lowercase letter, and all following characters must
+ # be a dash, lowercase letter, or digit, except the last character, which
+ # cannot be a dash.
+ "nats": [ # A list of NAT services created in this router.
+ { # Represents a Nat resource. It enables the VMs within the specified
+ # subnetworks to access Internet without external IP addresses. It specifies
+ # a list of subnetworks (and the ranges within) that want to use NAT.
+ # Customers can also provide the external IPs that would be used for NAT. GCP
+ # would auto-allocate ephemeral IPs if no external IPs are provided.
+ "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses.
+ # Must be one of: PREMIUM, STANDARD.
+ # If not specified, then the current
+ # project-level default tier is used.
+ "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs
+ # must be valid static external IPs that have been assigned to the NAT.
+ # These IPs should be used for updating/patching a NAT only.
+ "A String",
+ ],
+ "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation.
+ #
+ #
+ # If not specified, it is disabled by default.
+ #
+ #
+ # If set to true,
+ #
+ # - Dynamic Port Allocation will be enabled on this NAT
+ # config.
+ # - enableEndpointIndependentMapping cannot be set to true.
+ # - If minPorts is set, minPortsPerVm must be set to a
+ # power of two greater than or equal to 32. If minPortsPerVm is not set, a
+ # minimum of 32 ports will be allocated to a VM from this NAT
+ # config.
+ "enableEndpointIndependentMapping": True or False,
+ "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
+ # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
+ "A String",
+ ],
+ "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
+ "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.
+ "enable": True or False, # Indicates whether or not to export logs. This is false by default.
+ "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified,
+ # logs are exported for all connections handled by this NAT.
+ # This option can take one of the following values:
+ #
+ # - ERRORS_ONLY: Export logs only for connection failures.
+ # - TRANSLATIONS_ONLY: Export logs only for successful
+ # connections.
+ # - ALL: Export logs for all connections, successful and
+ # unsuccessful.
+ },
+ "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when
+ # Dynamic Port Allocation is enabled.
+ #
+ #
+ # If Dynamic Port Allocation is not enabled, this field has no effect.
+ #
+ #
+ # If Dynamic Port Allocation is enabled, and this field is set, it must be
+ # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
+ # is not set.
+ #
+ #
+ # If Dynamic Port Allocation is enabled and this field is not set,
+ # a maximum of 65536 ports will be allocated to a VM from this NAT
+ # config.
+ "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not
+ # set, a default number of ports is allocated to a VM. This is rounded
+ # up to the nearest power of 2. For example, if the value of this field is
+ # 50, at least 64 ports are allocated to a VM.
+ "name": "A String", # Unique name of this Nat service.
+ # The name must be 1-63 characters long and comply withRFC1035.
+ "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64
+ # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
+ # selected for the SubnetworkIpRangeToNat64Option above.
+ { # Specifies a subnetwork to enable NAT64.
+ "name": "A String", # URL for the subnetwork resource that will use NAT64.
+ },
+ ],
+ "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following
+ # values:
+ #
+ # - MANUAL_ONLY: Uses only Nat IP addresses provided by
+ # customers. When there are not enough specified Nat IPs, the Nat service
+ # fails for new VMs.
+ # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
+ # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
+ # be empty.
+ "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP
+ # addresses must be valid static external IP addresses assigned to the
+ # project.
+ "A String",
+ ],
+ "rules": [ # A list of rules associated with this NAT.
+ {
+ "action": { # The action to be enforced for traffic that matches this rule.
+ "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP
+ # addresses must be valid static external IP addresses assigned to the
+ # project.
+ # This field is used for public NAT.
+ "A String",
+ ],
+ "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this
+ # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
+ # This field is used for private NAT.
+ "A String",
+ ],
+ "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs
+ # must be valid static external IPs that have been assigned to the NAT.
+ # These IPs should be used for updating/patching a NAT rule only.
+ # This field is used for public NAT.
+ "A String",
+ ],
+ "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be
+ # drained. This is only supported on patch/update, and these
+ # subnetworks must have previously been used as active ranges in this
+ # NAT Rule.
+ # This field is used for private NAT.
+ "A String",
+ ],
+ },
+ "description": "A String", # An optional description of this rule.
+ "match": "A String", # CEL expression that specifies the match condition that egress traffic
+ # from a VM is evaluated against. If it evaluates to true, the
+ # corresponding `action` is enforced.
+ #
+ # The following examples are valid match expressions for public NAT:
+ #
+ # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip,
+ # '2.2.0.0/16')`
+ #
+ # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'`
+ #
+ # The following example is a valid match expression for private NAT:
+ #
+ # `nexthop.hub ==
+ # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'`
+ "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number
+ # must be a positive value between 0 and 65000, and
+ # must be unique among rules within a NAT.
+ },
+ ],
+ "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:
+ #
+ # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
+ # Subnetwork are allowed to Nat.
+ # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
+ # in every Subnetwork are allowed to Nat.
+ # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
+ # (specified in the field subnetwork below)
+ #
+ #
+ # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
+ # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
+ # should not be any other Router.Nat section in any Router for this network
+ # in this region.
+ "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following
+ # values:
+ #
+ # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
+ # every Subnetwork are allowed to Nat.
+ # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
+ # (specified in the field nat64_subnetwork below)
+ #
+ #
+ # The default is NAT64_OPTION_UNSPECIFIED.
+ # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
+ # Router.Nat section in this region can also enable NAT64 for any
+ # Subnetworks in this network. Other Router.Nat sections can still be
+ # present to enable NAT44 only.
+ "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT
+ # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
+ # SubnetworkIpRangeToNatOption above.
+ { # Defines the IP ranges that want to use NAT for a subnetwork.
+ "name": "A String", # URL for the subnetwork resource that will use NAT.
+ "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to
+ # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES"
+ # is one of the values in source_ip_ranges_to_nat.
+ "A String",
+ ],
+ "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All
+ # options of a single value are valid except
+ # NAT_IP_RANGE_OPTION_UNSPECIFIED.
+ # The only valid option with multiple values is: ["PRIMARY_IP_RANGE",
+ # "LIST_OF_SECONDARY_IP_RANGES"]
+ # Default: [ALL_IP_RANGES]
+ "A String",
+ ],
+ },
+ ],
+ "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
+ # if not set.
+ "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
+ # Defaults to 120s if not set.
+ "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
+ # not set.
+ "type": "A String", # Indicates whether this NAT is used for public or private IP
+ # translation. If unspecified, it defaults to PUBLIC.
+ "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
+ },
+ ],
+ "nccGateway": "A String", # URI of the ncc_gateway to which this router associated.
+ "network": "A String", # URI of the network to which this router belongs.
+ "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+ # The field is allowed for INSERT
+ # only. The keys/values to set on the resource should be specified in
+ # either ID { : } or Namespaced format
+ # { : }.
+ # For example the following are valid inputs:
+ # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+ # * {"123/environment" : "production", "345/abc" : "xyz"}
+ # Note:
+ # * Invalid combinations of ID & namespaced format is not supported. For
+ # instance: {"123/environment" : "tagValues/444"} is invalid.
+ # * Inconsistent format is not supported. For instance:
+ # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+ "a_key": "A String",
+ },
+ },
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ # You must specify this field as part of the HTTP request URL. It is
+ # not settable as a field in the request body.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ },
+}
+testIamPermissions(project, region, resource, body=None, x__xgafv=None)
+ Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, The name of the region for this request. (required)
+ resource: string, Name or id of the resource for this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+ # wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ # allowed.
+ "A String",
+ ],
+}
+update(project, region, router, body=None, requestId=None, x__xgafv=None)
+ Updates the specified Router resource with the data included in the
+request. This method conforms toPUT semantics, which requests that the state of the
+target resource be created or replaced with the state defined by the
+representation enclosed in the request message payload.
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource to update. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Cloud Router resource.
+ #
+ # For more information about Cloud Router, read theCloud
+ # Router overview.
+ "bgp": { # BGP information specific to this router.
+ "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+ # The options are DEFAULT or CUSTOM.
+ "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # is advertised to all peers of the router.
+ # These groups will be advertised in addition to any specified prefixes.
+ # Leave this field blank to advertise no custom groups.
+ "A String",
+ ],
+ "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # is advertised to all peers of the router.
+ # These IP ranges will be advertised in addition to any specified groups.
+ # Leave this field blank to advertise no custom IP ranges.
+ { # Description-tagged IP ranges for the router to advertise.
+ "description": "A String", # User-specified description for the IP range.
+ "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+ },
+ ],
+ "asn": 42, # Local BGP Autonomous System Number (ASN).
+ # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
+ # value will be fixed for this router resource. All VPN tunnels that link
+ # to this router will have the same local ASN.
+ "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It
+ # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
+ # least /30, even if the BGP sessions are over IPv6. It must not overlap
+ # with any IPv4 BGP session ranges.
+ #
+ #
+ # Other vendors commonly call this "router ID".
+ "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are
+ # sent to the peer.
+ #
+ #
+ # Hold time is three times the interval at which keepalive messages are
+ # sent, and the hold time is the maximum number of seconds allowed to
+ # elapse between successive keepalive messages that BGP receives from a
+ # peer.
+ #
+ #
+ # BGP will use the smaller of either the local hold time value or the
+ # peer's hold time value as the hold time for the BGP connection between
+ # the two peers.
+ #
+ #
+ # If set, this value must be between 20 and 60. The default is 20.
+ },
+ "bgpPeers": [ # BGP information that must be configured into the routing stack to
+ # establish BGP peering. This information must specify the peer ASN and
+ # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
+ {
+ "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+ "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode,
+ # which currently supports the following option:
+ #
+ # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This
+ # excludes any routes learned for subnets that use
+ # VPC Network Peering.
+ #
+ #
+ # Note that this field can only be populated if advertise_mode is CUSTOM
+ # and overrides the list defined for the router (in the "bgp" message).
+ # These groups are advertised in addition to any specified prefixes.
+ # Leave this field blank to advertise no custom groups.
+ "A String",
+ ],
+ "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+ # This field can only be populated if advertise_mode is CUSTOM and
+ # overrides the list defined for the router (in the "bgp" message).
+ # These IP ranges are advertised in addition to any specified groups.
+ # Leave this field blank to advertise no custom IP ranges.
+ { # Description-tagged IP ranges for the router to advertise.
+ "description": "A String", # User-specified description for the IP range.
+ "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+ },
+ ],
+ "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more
+ # than one matching route of maximum length, the routes with the lowest
+ # priority value win.
+ "bfd": { # BFD configuration for the BGP peering.
+ "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+ # received from the peer router. The actual value is negotiated between
+ # the two routers and is equal to the greater of this value and the
+ # transmit interval of the other router.
+ #
+ #
+ # If set, this value must be between 1000 and 30000.
+ #
+ #
+ # The default is 1000.
+ "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+ # transmitted to the peer router. The actual value is negotiated between
+ # the two routers and is equal to the greater of this value and the
+ # corresponding receive interval of the other router.
+ #
+ #
+ # If set, this value must be between 1000 and 30000.
+ #
+ #
+ # The default is 1000.
+ "multiplier": 42, # The number of consecutive BFD packets that must be missed
+ # before BFD declares that a peer is unavailable.
+ #
+ #
+ # If set, the value must be a value between 5 and 16.
+ #
+ #
+ # The default is 5.
+ "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.
+ #
+ #
+ # If set to ACTIVE, the Cloud Router will initiate the BFD session for
+ # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
+ # peer router to initiate the BFD session for this BGP peer. If set to
+ # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
+ },
+ "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP
+ # session.
+ {
+ "range": "A String", # The custom learned route IP address range. Must be a valid
+ # CIDR-formatted prefix. If an IP address is provided without a subnet
+ # mask, it is interpreted as, for IPv4, a `/32` singular IP address
+ # range, and, for IPv6, `/128`.
+ },
+ ],
+ "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This
+ # value is applied to all custom learned route ranges for the session.
+ # You can choose a value from `0` to `65335`. If you don't provide a
+ # value, Google Cloud assigns a priority of `100` to the ranges.
+ "enable": "A String", # The status of the BGP peer connection.
+ #
+ #
+ # If set to FALSE, any active session with the peer is terminated and
+ # all associated routing information is removed. If set to TRUE, the
+ # peer connection can be established with routing information. The default
+ # is TRUE.
+ "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
+ # the peerIpAddress is version 4.
+ "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
+ # peerIpAddress is version 6.
+ "exportPolicies": [ # List of export policies applied to this peer, in the order they must be
+ # evaluated. The name must correspond to an existing policy that has
+ # ROUTE_POLICY_TYPE_EXPORT type.
+ "A String",
+ ],
+ "importPolicies": [ # List of import policies applied to this peer, in the order they must be
+ # evaluated. The name must correspond to an existing policy that has
+ # ROUTE_POLICY_TYPE_IMPORT type.
+ "A String",
+ ],
+ "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+ "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+ "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
+ "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
+ "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer.
+ #
+ # - MANAGED_BY_USER is the default value and can be managed by you
+ # or other users
+ # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
+ # by Cloud Interconnect, specifically by an InterconnectAttachment of type
+ # PARTNER. Google automatically creates, updates, and deletes this type of
+ # BGP peer when the PARTNER InterconnectAttachment is created, updated,
+ # or deleted.
+ "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the
+ # name of one of the entries in the Router.md5_authentication_keys. The
+ # field must comply with RFC1035.
+ "name": "A String", # Name of this BGP peer.
+ # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
+ # characters long and match the regular expression
+ # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+ # lowercase letter, and all following characters must be a dash, lowercase
+ # letter, or digit, except the last character, which cannot be a dash.
+ "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
+ # a different value.
+ "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform.
+ "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform.
+ "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform.
+ "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router
+ # appliances such as Next Gen Firewalls, Virtual Routers, or Router
+ # Appliances. The VM instance must be located in zones contained in the
+ # same region as this Cloud Router.
+ # The VM instance is the peer side of the BGP session.
+ },
+ ],
+ "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+ # text format.
+ "description": "A String", # An optional description of this resource. Provide this property when you
+ # create the resource.
+ "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN
+ # attachments (interconnectAttachments).
+ "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+ # defined by the server.
+ "interfaces": [ # Router interfaces.
+ # To create a BGP peer that uses a router interface,
+ # the interface must have one of the following fields specified:
+ #
+ # - linkedVpnTunnel
+ # - linkedInterconnectAttachment
+ # - subnetwork
+ #
+ #
+ # You can create a router interface without any of these fields specified.
+ # However, you cannot create a BGP peer that uses that interface.
+ {
+ "ipRange": "A String", # IP address and range of the interface.
+ #
+ # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
+ # be a CIDR-formatted string, for example, 169.254.0.1/30.
+ # Note: Do not truncate the IP address, as it represents the IP address of
+ # the interface.
+ # - For Internet Protocol version 6 (IPv6), the value
+ # must be a unique local address (ULA) range from fdff:1::/64
+ # with a mask length of 126 or less. This value should be a CIDR-formatted
+ # string, for example, fdff:1::1/112. Within the router's
+ # VPC, this IPv6 prefix will be reserved exclusively for this connection
+ # and cannot be used for any other purpose.
+ "ipVersion": "A String", # IP version of this interface.
+ "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region
+ # as the router. Each interface can have one linked resource, which can be
+ # a VPN tunnel, an Interconnect attachment, or a subnetwork.
+ "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the
+ # router. Each interface can have one linked resource, which can be
+ # a VPN tunnel, an Interconnect attachment, or a subnetwork.
+ "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface.
+ #
+ # - MANAGED_BY_USER is the default value and can be managed directly
+ # by users.
+ # - MANAGED_BY_ATTACHMENT is an interface that is configured and
+ # managed by Cloud Interconnect, specifically, by an InterconnectAttachment
+ # of type PARTNER. Google automatically creates, updates, and deletes
+ # this type of interface when the PARTNER InterconnectAttachment is
+ # created, updated, or deleted.
+ "name": "A String", # Name of this interface entry.
+ # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
+ # characters long and match the regular expression
+ # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+ # lowercase letter, and all following characters must be a dash, lowercase
+ # letter, or digit, except the last character, which cannot be a dash.
+ "privateIpAddress": "A String", # The regional private internal IP address that is used to establish
+ # BGP sessions to a VM instance acting as a third-party
+ # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
+ # an SD-WAN VM.
+ "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface
+ # you are creating. The redundantInterface must belong to the same Cloud
+ # Router as the interface here. To establish the BGP session to a Router
+ # Appliance VM, you must create two BGP peers. The two BGP peers must be
+ # attached to two separate interfaces that are redundant with each other.
+ # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
+ # be 1-63 characters long and match the regular expression
+ # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+ # lowercase letter, and all following characters must be a dash, lowercase
+ # letter, or digit, except the last character, which cannot be a dash.
+ "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which
+ # must be in the same region as the Cloud Router.
+ # When you establish a BGP session to a VM instance using this interface,
+ # the VM instance must belong to the same subnetwork as the subnetwork
+ # specified here.
+ },
+ ],
+ "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for
+ # routers.
+ "md5AuthenticationKeys": [ # Keys used for MD5 authentication.
+ {
+ "key": "A String", # [Input only] Value of the key.
+ #
+ # For patch and update calls, it can be skipped to
+ # copy the value from the previous configuration. This is allowed if the
+ # key with the same name existed before the operation. Maximum length is 80
+ # characters. Can only contain printable ASCII characters.
+ "name": "A String", # Name used to identify the key.
+ #
+ # Must be unique within a router. Must be referenced by exactly
+ # one bgpPeer. Must comply withRFC1035.
+ },
+ ],
+ "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+ # The name must be 1-63 characters long, and comply withRFC1035.
+ # Specifically, the name must be 1-63 characters long and match the regular
+ # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+ # character must be a lowercase letter, and all following characters must
+ # be a dash, lowercase letter, or digit, except the last character, which
+ # cannot be a dash.
+ "nats": [ # A list of NAT services created in this router.
+ { # Represents a Nat resource. It enables the VMs within the specified
+ # subnetworks to access Internet without external IP addresses. It specifies
+ # a list of subnetworks (and the ranges within) that want to use NAT.
+ # Customers can also provide the external IPs that would be used for NAT. GCP
+ # would auto-allocate ephemeral IPs if no external IPs are provided.
+ "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses.
+ # Must be one of: PREMIUM, STANDARD.
+ # If not specified, then the current
+ # project-level default tier is used.
+ "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs
+ # must be valid static external IPs that have been assigned to the NAT.
+ # These IPs should be used for updating/patching a NAT only.
+ "A String",
+ ],
+ "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation.
+ #
+ #
+ # If not specified, it is disabled by default.
+ #
+ #
+ # If set to true,
+ #
+ # - Dynamic Port Allocation will be enabled on this NAT
+ # config.
+ # - enableEndpointIndependentMapping cannot be set to true.
+ # - If minPorts is set, minPortsPerVm must be set to a
+ # power of two greater than or equal to 32. If minPortsPerVm is not set, a
+ # minimum of 32 ports will be allocated to a VM from this NAT
+ # config.
+ "enableEndpointIndependentMapping": True or False,
+ "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
+ # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
+ "A String",
+ ],
+ "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
+ "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.
+ "enable": True or False, # Indicates whether or not to export logs. This is false by default.
+ "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified,
+ # logs are exported for all connections handled by this NAT.
+ # This option can take one of the following values:
+ #
+ # - ERRORS_ONLY: Export logs only for connection failures.
+ # - TRANSLATIONS_ONLY: Export logs only for successful
+ # connections.
+ # - ALL: Export logs for all connections, successful and
+ # unsuccessful.
+ },
+ "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when
+ # Dynamic Port Allocation is enabled.
+ #
+ #
+ # If Dynamic Port Allocation is not enabled, this field has no effect.
+ #
+ #
+ # If Dynamic Port Allocation is enabled, and this field is set, it must be
+ # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
+ # is not set.
+ #
+ #
+ # If Dynamic Port Allocation is enabled and this field is not set,
+ # a maximum of 65536 ports will be allocated to a VM from this NAT
+ # config.
+ "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not
+ # set, a default number of ports is allocated to a VM. This is rounded
+ # up to the nearest power of 2. For example, if the value of this field is
+ # 50, at least 64 ports are allocated to a VM.
+ "name": "A String", # Unique name of this Nat service.
+ # The name must be 1-63 characters long and comply withRFC1035.
+ "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64
+ # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
+ # selected for the SubnetworkIpRangeToNat64Option above.
+ { # Specifies a subnetwork to enable NAT64.
+ "name": "A String", # URL for the subnetwork resource that will use NAT64.
+ },
+ ],
+ "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following
+ # values:
+ #
+ # - MANUAL_ONLY: Uses only Nat IP addresses provided by
+ # customers. When there are not enough specified Nat IPs, the Nat service
+ # fails for new VMs.
+ # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
+ # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
+ # be empty.
+ "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP
+ # addresses must be valid static external IP addresses assigned to the
+ # project.
+ "A String",
+ ],
+ "rules": [ # A list of rules associated with this NAT.
+ {
+ "action": { # The action to be enforced for traffic that matches this rule.
+ "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP
+ # addresses must be valid static external IP addresses assigned to the
+ # project.
+ # This field is used for public NAT.
+ "A String",
+ ],
+ "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this
+ # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
+ # This field is used for private NAT.
+ "A String",
+ ],
+ "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs
+ # must be valid static external IPs that have been assigned to the NAT.
+ # These IPs should be used for updating/patching a NAT rule only.
+ # This field is used for public NAT.
+ "A String",
+ ],
+ "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be
+ # drained. This is only supported on patch/update, and these
+ # subnetworks must have previously been used as active ranges in this
+ # NAT Rule.
+ # This field is used for private NAT.
+ "A String",
+ ],
+ },
+ "description": "A String", # An optional description of this rule.
+ "match": "A String", # CEL expression that specifies the match condition that egress traffic
+ # from a VM is evaluated against. If it evaluates to true, the
+ # corresponding `action` is enforced.
+ #
+ # The following examples are valid match expressions for public NAT:
+ #
+ # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip,
+ # '2.2.0.0/16')`
+ #
+ # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'`
+ #
+ # The following example is a valid match expression for private NAT:
+ #
+ # `nexthop.hub ==
+ # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'`
+ "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number
+ # must be a positive value between 0 and 65000, and
+ # must be unique among rules within a NAT.
+ },
+ ],
+ "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:
+ #
+ # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
+ # Subnetwork are allowed to Nat.
+ # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
+ # in every Subnetwork are allowed to Nat.
+ # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
+ # (specified in the field subnetwork below)
+ #
+ #
+ # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
+ # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
+ # should not be any other Router.Nat section in any Router for this network
+ # in this region.
+ "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following
+ # values:
+ #
+ # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
+ # every Subnetwork are allowed to Nat.
+ # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
+ # (specified in the field nat64_subnetwork below)
+ #
+ #
+ # The default is NAT64_OPTION_UNSPECIFIED.
+ # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
+ # Router.Nat section in this region can also enable NAT64 for any
+ # Subnetworks in this network. Other Router.Nat sections can still be
+ # present to enable NAT44 only.
+ "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT
+ # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
+ # SubnetworkIpRangeToNatOption above.
+ { # Defines the IP ranges that want to use NAT for a subnetwork.
+ "name": "A String", # URL for the subnetwork resource that will use NAT.
+ "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to
+ # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES"
+ # is one of the values in source_ip_ranges_to_nat.
+ "A String",
+ ],
+ "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All
+ # options of a single value are valid except
+ # NAT_IP_RANGE_OPTION_UNSPECIFIED.
+ # The only valid option with multiple values is: ["PRIMARY_IP_RANGE",
+ # "LIST_OF_SECONDARY_IP_RANGES"]
+ # Default: [ALL_IP_RANGES]
+ "A String",
+ ],
+ },
+ ],
+ "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
+ # if not set.
+ "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
+ # Defaults to 120s if not set.
+ "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
+ # not set.
+ "type": "A String", # Indicates whether this NAT is used for public or private IP
+ # translation. If unspecified, it defaults to PUBLIC.
+ "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
+ },
+ ],
+ "nccGateway": "A String", # URI of the ncc_gateway to which this router associated.
+ "network": "A String", # URI of the network to which this router belongs.
+ "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+ # as part of resource payload.
+ "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+ # The field is allowed for INSERT
+ # only. The keys/values to set on the resource should be specified in
+ # either ID { : } or Namespaced format
+ # { : }.
+ # For example the following are valid inputs:
+ # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+ # * {"123/environment" : "production", "345/abc" : "xyz"}
+ # Note:
+ # * Invalid combinations of ID & namespaced format is not supported. For
+ # instance: {"123/environment" : "tagValues/444"} is invalid.
+ # * Inconsistent format is not supported. For instance:
+ # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+ "a_key": "A String",
+ },
+ },
+ "region": "A String", # [Output Only] URI of the region where the router resides.
+ # You must specify this field as part of the HTTP request URL. It is
+ # not settable as a field in the request body.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
},
- ],
- "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following
- # values:
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `user@example.com` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
#
- # - MANUAL_ONLY: Uses only Nat IP addresses provided by
- # customers. When there are not enough specified Nat IPs, the Nat service
- # fails for new VMs.
- # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
- # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
- # be empty.
- "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP
- # addresses must be valid static external IP addresses assigned to the
- # project.
- "A String",
- ],
- "rules": [ # A list of rules associated with this NAT.
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
{
- "action": { # The action to be enforced for traffic that matches this rule.
- "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP
- # addresses must be valid static external IP addresses assigned to the
- # project.
- # This field is used for public NAT.
- "A String",
- ],
- "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this
- # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
- # This field is used for private NAT.
- "A String",
- ],
- "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs
- # must be valid static external IPs that have been assigned to the NAT.
- # These IPs should be used for updating/patching a NAT rule only.
- # This field is used for public NAT.
- "A String",
- ],
- "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be
- # drained. This is only supported on patch/update, and these
- # subnetworks must have previously been used as active ranges in this
- # NAT Rule.
- # This field is used for private NAT.
- "A String",
- ],
- },
- "description": "A String", # An optional description of this rule.
- "match": "A String", # CEL expression that specifies the match condition that egress traffic
- # from a VM is evaluated against. If it evaluates to true, the
- # corresponding `action` is enforced.
- #
- # The following examples are valid match expressions for public NAT:
- #
- # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip,
- # '2.2.0.0/16')`
- #
- # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'`
- #
- # The following example is a valid match expression for private NAT:
- #
- # `nexthop.hub ==
- # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'`
- "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number
- # must be a positive value between 0 and 65000, and
- # must be unique among rules within a NAT.
- },
- ],
- "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:
- #
- # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
- # Subnetwork are allowed to Nat.
- # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
- # in every Subnetwork are allowed to Nat.
- # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
- # (specified in the field subnetwork below)
- #
- #
- # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
- # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
- # should not be any other Router.Nat section in any Router for this network
- # in this region.
- "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following
- # values:
- #
- # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
- # every Subnetwork are allowed to Nat.
- # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
- # (specified in the field nat64_subnetwork below)
- #
- #
- # The default is NAT64_OPTION_UNSPECIFIED.
- # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
- # Router.Nat section in this region can also enable NAT64 for any
- # Subnetworks in this network. Other Router.Nat sections can still be
- # present to enable NAT44 only.
- "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT
- # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
- # SubnetworkIpRangeToNatOption above.
- { # Defines the IP ranges that want to use NAT for a subnetwork.
- "name": "A String", # URL for the subnetwork resource that will use NAT.
- "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to
- # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES"
- # is one of the values in source_ip_ranges_to_nat.
- "A String",
- ],
- "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All
- # options of a single value are valid except
- # NAT_IP_RANGE_OPTION_UNSPECIFIED.
- # The only valid option with multiple values is: ["PRIMARY_IP_RANGE",
- # "LIST_OF_SECONDARY_IP_RANGES"]
- # Default: [ALL_IP_RANGES]
- "A String",
- ],
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
- "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
- # if not set.
- "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
- # Defaults to 120s if not set.
- "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
- # not set.
- "type": "A String", # Indicates whether this NAT is used for public or private IP
- # translation. If unspecified, it defaults to PUBLIC.
- "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
- "nccGateway": "A String", # URI of the ncc_gateway to which this router associated.
- "network": "A String", # URI of the network to which this router belongs.
- "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
- # as part of resource payload.
- "resourceManagerTags": { # Tag keys/values directly bound to this resource.
- # The field is allowed for INSERT
- # only. The keys/values to set on the resource should be specified in
- # either ID { : } or Namespaced format
- # { : }.
- # For example the following are valid inputs:
- # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
- # * {"123/environment" : "production", "345/abc" : "xyz"}
- # Note:
- # * Invalid combinations of ID & namespaced format is not supported. For
- # instance: {"123/environment" : "tagValues/444"} is invalid.
- # * Inconsistent format is not supported. For instance:
- # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
- "a_key": "A String",
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}
+updateNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)
+ Updates or creates new Named Set
+
+Args:
+ project: string, Project ID for this request. (required)
+ region: string, Name of the region for this request. (required)
+ router: string, Name of the Router resource where Named Set is defined. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "description": "A String", # An optional description of named set.
+ "elements": [ # CEL expressions that are comparable to constructs of this set's type
+ # (see Policy Language).
+ { # Represents a textual expression in the Common Expression Language (CEL)
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
},
- },
- "region": "A String", # [Output Only] URI of the region where the router resides.
- # You must specify this field as part of the HTTP request URL. It is
- # not settable as a field in the request body.
- "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ ],
+ "fingerprint": "A String", # A fingerprint for the Named Set being applied to this Router, which is
+ # essentially a hash of the Named Set used for optimistic locking.
+ # The fingerprint is initially generated by Compute Engine and changes
+ # after every request to modify or update the Named Set. You must always
+ # provide an up-to-date fingerprint hash in order to update or change
+ # labels.
+ #
+ # To see the latest fingerprint, make a getNamedSet() request
+ # to retrieve a Named Set.
+ "name": "A String", # This set's name, which must be a resource ID segment and unique within all
+ # named sets owned by the Router. Name should conform to RFC1035.
+ "type": "A String", # This named set's type
}
requestId: string, An optional request ID to identify requests. Specify a unique request ID so
diff --git a/docs/dyn/compute_beta.snapshotGroups.html b/docs/dyn/compute_beta.snapshotGroups.html
new file mode 100644
index 0000000000..df5f2353c8
--- /dev/null
+++ b/docs/dyn/compute_beta.snapshotGroups.html
@@ -0,0 +1,2218 @@
+
+
+
+Compute Engine API . snapshotGroups
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ delete(project, snapshotGroup, requestId=None, x__xgafv=None)
+Deletes the specified SnapshotGroup resource
+
+ get(project, snapshotGroup, x__xgafv=None)
+returns the specified SnapshotGroup resource.
+
+ getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)
+Gets the access control policy for a resource. May be empty if no such
+
+ insert(project, body=None, requestId=None, x__xgafv=None)
+Creates a snapshot group in the specified project using the data included
+
+retrieves the list of SnapshotGroup resources contained within
+
+Retrieves the next page of results.
+
+ setIamPolicy(project, resource, body=None, x__xgafv=None)
+Sets the access control policy on the specified resource.
+
+ testIamPermissions(project, resource, body=None, x__xgafv=None)
+Returns permissions that a caller has on the specified resource.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ delete(project, snapshotGroup, requestId=None, x__xgafv=None)
+ Deletes the specified SnapshotGroup resource
+
+Args:
+ project: string, Project ID for this request. (required)
+ snapshotGroup: string, Name of the SnapshotGroup resource to delete. (required)
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `user@example.com` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}
+
+
+
+ get(project, snapshotGroup, x__xgafv=None)
+ returns the specified SnapshotGroup resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ snapshotGroup: string, Name of the SnapshotGroup resource to return. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a SnapshotGroup resource.
+ #
+ # A snapshot group is a set of snapshots that represents a point in time state
+ # of a consistency group.
+ "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+ # text format.
+ "description": "A String", # Optional. An optional description of this resource. Provide this property when you
+ # create the resource.
+ "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+ # defined by the server.
+ "kind": "compute#snapshotGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#snapshotGroup for SnapshotGroup
+ # resources.
+ "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created.
+ # The name must be 1-63 characters long, and comply withRFC1035.
+ # Specifically, the name must be 1-63 characters long and match the regular
+ # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+ # character must be a lowercase letter, and all following characters must be
+ # a dash, lowercase letter, or digit, except the last character, which cannot
+ # be a dash.
+ "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+ "sourceInfo": { # Output only. [Output Only]
+ "consistencyGroup": "A String",
+ "consistencyGroupId": "A String",
+ },
+ "sourceInstantSnapshotGroup": "A String", # Input field for the source instant snapshot group.
+ "sourceInstantSnapshotGroupInfo": { # Output only. [Output Only]
+ "instantSnapshotGroup": "A String",
+ "instantSnapshotGroupId": "A String",
+ },
+ "status": "A String", # Output only. [Output Only]
+}
+
+
+
+ getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)
+ Gets the access control policy for a resource. May be empty if no such
+policy or resource exists.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name or id of the resource for this request. (required)
+ optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
+ #
+ #
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members`, or principals, to a single `role`. Principals can be user
+ # accounts, service accounts, Google groups, and domains (such as G Suite). A
+ # `role` is a named list of permissions; each `role` can be an IAM predefined
+ # role or a user-created custom role.
+ #
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # **JSON example:**
+ #
+ # ```
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # ]
+ # },
+ # {
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
+ # }
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
+ # }
+ # ```
+ #
+ # **YAML example:**
+ #
+ # ```
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
+ # - members:
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # etag: BwWWja0YfJA=
+ # version: 3
+ # ```
+ #
+ # For a description of IAM and its features, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # },
+ # {
+ # "log_type": "ADMIN_READ"
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ"
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+ # `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+ # may specify a `condition` that determines how and when the `bindings` are
+ # applied. Each of the `bindings` must contain at least one principal.
+ #
+ # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+ # of these principals can be Google groups. Each occurrence of a principal
+ # counts towards these limits. For example, if the `bindings` grant 50
+ # different roles to `user:alice@example.com`, and not to any other
+ # principal, then you can add another 1,450 principals to the `bindings` in
+ # the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the principals in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ # Does not include identities that come from external identity providers
+ # (IdPs) through identity federation.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a Google
+ # service account. For example,
+ # `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+ # identifier for a
+ # [Kubernetes service
+ # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+ # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ #
+ #
+ #
+ # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workforce identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+ # All workforce identities in a group.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All workforce identities with a specific attribute value.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+ # All identities in a workforce identity pool.
+ #
+ # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workload identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+ # A workload identity pool group.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All identities in a workload identity pool with a certain attribute.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+ # All identities in a workload identity pool.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # Deleted single identity in a workforce identity pool. For example,
+ # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ #
+ # For an overview of the IAM roles and permissions, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+ # a list of the available pre-defined roles, see
+ # [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
+
+ insert(project, body=None, requestId=None, x__xgafv=None)
+ Creates a snapshot group in the specified project using the data included
+in the request.
+
+Args:
+ project: string, Project ID for this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a SnapshotGroup resource.
+ #
+ # A snapshot group is a set of snapshots that represents a point in time state
+ # of a consistency group.
+ "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+ # text format.
+ "description": "A String", # Optional. An optional description of this resource. Provide this property when you
+ # create the resource.
+ "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+ # defined by the server.
+ "kind": "compute#snapshotGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#snapshotGroup for SnapshotGroup
+ # resources.
+ "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created.
+ # The name must be 1-63 characters long, and comply withRFC1035.
+ # Specifically, the name must be 1-63 characters long and match the regular
+ # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+ # character must be a lowercase letter, and all following characters must be
+ # a dash, lowercase letter, or digit, except the last character, which cannot
+ # be a dash.
+ "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+ "sourceInfo": { # Output only. [Output Only]
+ "consistencyGroup": "A String",
+ "consistencyGroupId": "A String",
+ },
+ "sourceInstantSnapshotGroup": "A String", # Input field for the source instant snapshot group.
+ "sourceInstantSnapshotGroupInfo": { # Output only. [Output Only]
+ "instantSnapshotGroup": "A String",
+ "instantSnapshotGroupId": "A String",
+ },
+ "status": "A String", # Output only. [Output Only]
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource.
+ #
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+ # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+ # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+ #
+ # You can use an operation resource to manage asynchronous API requests.
+ # For more information, readHandling
+ # API responses.
+ #
+ # Operations can be global, regional or zonal.
+ #
+ # - For global operations, use the `globalOperations`
+ # resource.
+ # - For regional operations, use the
+ # `regionOperations` resource.
+ # - For zonal operations, use
+ # the `zoneOperations` resource.
+ #
+ #
+ #
+ # For more information, read
+ # Global, Regional, and Zonal Resources.
+ #
+ # Note that completed Operation resources have a limited
+ # retention period.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+ # Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is
+ # set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+ # text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation,
+ # this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this
+ # operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+ # details. There is a set of defined message types to use for providing
+ # details.The syntax depends on the error code. For example,
+ # QuotaExceededInfo will have details when the error code is
+ # QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details.
+ #
+ # Example of an error when contacting the "pubsub.googleapis.com" API when it
+ # is not enabled:
+ #
+ # { "reason": "API_DISABLED"
+ # "domain": "googleapis.com"
+ # "metadata": {
+ # "resource": "projects/123",
+ # "service": "pubsub.googleapis.com"
+ # }
+ # }
+ #
+ # This response indicates that the pubsub.googleapis.com API is not enabled.
+ #
+ # Example of an error that is returned when attempting to create a Spanner
+ # instance in a region that is out of stock:
+ #
+ # { "reason": "STOCKOUT"
+ # "domain": "spanner.googleapis.com",
+ # "metadata": {
+ # "availableRegions": "us-central1,us-east2"
+ # }
+ # }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+ # is typically the registered service name of the tool or product that
+ # generates the error. Example: "pubsub.googleapis.com". If the error is
+ # generated by some common infrastructure, the error domain must be a
+ # globally unique value that identifies the infrastructure. For Google API
+ # infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error.
+ #
+ # Keys must match a regular expression of `a-z+` but should
+ # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+ # length. When identifying the current value of an exceeded limit, the units
+ # should be contained in the key, not the value. For example, rather than
+ # `{"instanceLimit": "100/request"}`, should be returned as,
+ # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+ # instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the
+ # proximate cause of the error. Error reasons are unique within a particular
+ # domain of errors. This should be at most 63 characters and match a
+ # regular expression of `A-Z+[A-Z0-9]`, which represents
+ # UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action.
+ #
+ # For example, if a quota check failed with an error indicating the calling
+ # project hasn't enabled the accessed service, this can contain a URL pointing
+ # directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user
+ # which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at
+ # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+ # Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+ # type or metric.
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+ # or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ "rolloutStatus": "A String", # Rollout status of the future quota limit.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+ # This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+ # message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+ # status code that was returned. For example, a `404` means the
+ # resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+ # defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested.
+ # This value is inRFC3339
+ # text format.
+ "instancesBulkInsertOperationMetadata": {
+ "perLocationStatus": { # Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+ "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+ "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+ # error.
+ "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+ # if the flow is rolling forward or rolling back.
+ "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+ },
+ },
+ },
+ "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+ # Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+ # group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+ # `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+ # There is no requirement that this be linear or support any granularity of
+ # operations. This should not be used to guess when the operation will be
+ # complete. This number should monotonically increase as the operation
+ # progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+ # applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+ # this field will contain information on all underlying zonal actions and
+ # their state.
+ "clientOperationId": "A String", # [Output Only] The client operation id.
+ "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+ # Example key: zones/us-central1-a
+ "a_key": {
+ "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+ # populated.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ },
+ "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+ # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+ },
+ },
+ },
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+ # This value is inRFC3339
+ # text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the
+ # following:
+ # `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+ # operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+ # of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+ # operations related to creating a snapshot, this points to the disk
+ # that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example:
+ # `user@example.com` or
+ # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the
+ # operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+ # applicable when performing per-zone operations.
+}
+
+
+
+ list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+ retrieves the list of SnapshotGroup resources contained within
+the specified project.
+
+Args:
+ project: string, Project ID for this request. (required)
+ filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+ maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+ orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+ pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+ returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Contains a list of SnapshotGroup resources.
+ "etag": "A String",
+ "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "items": [ # A list of SnapshotGroup resources.
+ { # Represents a SnapshotGroup resource.
+ #
+ # A snapshot group is a set of snapshots that represents a point in time state
+ # of a consistency group.
+ "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+ # text format.
+ "description": "A String", # Optional. An optional description of this resource. Provide this property when you
+ # create the resource.
+ "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+ # defined by the server.
+ "kind": "compute#snapshotGroup", # Output only. [Output Only] Type of the resource. Alwayscompute#snapshotGroup for SnapshotGroup
+ # resources.
+ "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created.
+ # The name must be 1-63 characters long, and comply withRFC1035.
+ # Specifically, the name must be 1-63 characters long and match the regular
+ # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+ # character must be a lowercase letter, and all following characters must be
+ # a dash, lowercase letter, or digit, except the last character, which cannot
+ # be a dash.
+ "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+ "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource's resource id.
+ "sourceInfo": { # Output only. [Output Only]
+ "consistencyGroup": "A String",
+ "consistencyGroupId": "A String",
+ },
+ "sourceInstantSnapshotGroup": "A String", # Input field for the source instant snapshot group.
+ "sourceInstantSnapshotGroupInfo": { # Output only. [Output Only]
+ "instantSnapshotGroup": "A String",
+ "instantSnapshotGroupId": "A String",
+ },
+ "status": "A String", # Output only. [Output Only]
+ },
+ ],
+ "kind": "compute#snapshotGroupsList", # Output only. Type of resource.
+ "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+ # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+ # the query parameter pageToken in the next list request.
+ # Subsequent list requests will have their own nextPageToken to
+ # continue paging through the results.
+ "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+ "unreachables": [ # Output only. [Output Only] Unreachable resources.
+ # end_interface: MixerListResponseWithEtagBuilder
+ "A String",
+ ],
+ "warning": { # [Output Only] Informational warning message.
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+ # Engine returns NO_RESULTS_ON_PAGE if there
+ # are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key:
+ # value format. For example:
+ #
+ # "data": [
+ # {
+ # "key": "scope",
+ # "value": "zones/us-east1-d"
+ # }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being
+ # returned. For example, for warnings where there are no results in a list
+ # request for a particular zone, this key might be scope and
+ # the key value might be the zone name. Other examples might be a key
+ # indicating a deprecated resource and a suggested replacement, or a
+ # warning about invalid network settings (for example, if an instance
+ # attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
+ setIamPolicy(project, resource, body=None, x__xgafv=None)
+ Sets the access control policy on the specified resource.
+Replaces any existing policy.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name or id of the resource for this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "bindings": [ # Flatten Policy to create a backward compatible wire-format.
+ # Deprecated. Use 'policy' to specify bindings.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the principals in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ # Does not include identities that come from external identity providers
+ # (IdPs) through identity federation.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a Google
+ # service account. For example,
+ # `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+ # identifier for a
+ # [Kubernetes service
+ # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+ # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ #
+ #
+ #
+ # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workforce identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+ # All workforce identities in a group.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All workforce identities with a specific attribute value.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+ # All identities in a workforce identity pool.
+ #
+ # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workload identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+ # A workload identity pool group.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All identities in a workload identity pool with a certain attribute.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+ # All identities in a workload identity pool.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # Deleted single identity in a workforce identity pool. For example,
+ # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ #
+ # For an overview of the IAM roles and permissions, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+ # a list of the available pre-defined roles, see
+ # [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # Flatten Policy to create a backward compatible wire-format.
+ # Deprecated. Use 'policy' to specify the etag.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the 'resource'. The size of
+ # the policy is limited to a few 10s of KB. An empty policy is in general a
+ # valid policy but certain services (like Projects) might reject them.
+ # controls for Google Cloud resources.
+ #
+ #
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members`, or principals, to a single `role`. Principals can be user
+ # accounts, service accounts, Google groups, and domains (such as G Suite). A
+ # `role` is a named list of permissions; each `role` can be an IAM predefined
+ # role or a user-created custom role.
+ #
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # **JSON example:**
+ #
+ # ```
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # ]
+ # },
+ # {
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
+ # }
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
+ # }
+ # ```
+ #
+ # **YAML example:**
+ #
+ # ```
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
+ # - members:
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # etag: BwWWja0YfJA=
+ # version: 3
+ # ```
+ #
+ # For a description of IAM and its features, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # },
+ # {
+ # "log_type": "ADMIN_READ"
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ"
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+ # `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+ # may specify a `condition` that determines how and when the `bindings` are
+ # applied. Each of the `bindings` must contain at least one principal.
+ #
+ # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+ # of these principals can be Google groups. Each occurrence of a principal
+ # counts towards these limits. For example, if the `bindings` grant 50
+ # different roles to `user:alice@example.com`, and not to any other
+ # principal, then you can add another 1,450 principals to the `bindings` in
+ # the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the principals in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ # Does not include identities that come from external identity providers
+ # (IdPs) through identity federation.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a Google
+ # service account. For example,
+ # `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+ # identifier for a
+ # [Kubernetes service
+ # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+ # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ #
+ #
+ #
+ # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workforce identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+ # All workforce identities in a group.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All workforce identities with a specific attribute value.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+ # All identities in a workforce identity pool.
+ #
+ # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workload identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+ # A workload identity pool group.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All identities in a workload identity pool with a certain attribute.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+ # All identities in a workload identity pool.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # Deleted single identity in a workforce identity pool. For example,
+ # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ #
+ # For an overview of the IAM roles and permissions, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+ # a list of the available pre-defined roles, see
+ # [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
+ #
+ #
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members`, or principals, to a single `role`. Principals can be user
+ # accounts, service accounts, Google groups, and domains (such as G Suite). A
+ # `role` is a named list of permissions; each `role` can be an IAM predefined
+ # role or a user-created custom role.
+ #
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # **JSON example:**
+ #
+ # ```
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # ]
+ # },
+ # {
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
+ # }
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
+ # }
+ # ```
+ #
+ # **YAML example:**
+ #
+ # ```
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
+ # - members:
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # etag: BwWWja0YfJA=
+ # version: 3
+ # ```
+ #
+ # For a description of IAM and its features, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # },
+ # {
+ # "log_type": "ADMIN_READ"
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ"
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+ # `aliya@example.com` from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally,
+ # may specify a `condition` that determines how and when the `bindings` are
+ # applied. Each of the `bindings` must contain at least one principal.
+ #
+ # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
+ # of these principals can be Google groups. Each occurrence of a principal
+ # counts towards these limits. For example, if the `bindings` grant 50
+ # different roles to `user:alice@example.com`, and not to any other
+ # principal, then you can add another 1,450 principals to the `bindings` in
+ # the `Policy`.
+ { # Associates `members`, or principals, with a `role`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the principals in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ # Does not include identities that come from external identity providers
+ # (IdPs) through identity federation.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a Google
+ # service account. For example,
+ # `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
+ # identifier for a
+ # [Kubernetes service
+ # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
+ # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ #
+ #
+ #
+ # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workforce identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
+ # All workforce identities in a group.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All workforce identities with a specific attribute value.
+ #
+ # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
+ # All identities in a workforce identity pool.
+ #
+ # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
+ # A single identity in a workload identity pool.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
+ # A workload identity pool group.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
+ # All identities in a workload identity pool with a certain attribute.
+ #
+ # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
+ # All identities in a workload identity pool.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
+ # Deleted single identity in a workforce identity pool. For example,
+ # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of `members`, or principals.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ #
+ # For an overview of the IAM roles and permissions, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
+ # a list of the available pre-defined roles, see
+ # [here](https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
+
+ testIamPermissions(project, resource, body=None, x__xgafv=None)
+ Returns permissions that a caller has on the specified resource.
+
+Args:
+ project: string, Project ID for this request. (required)
+ resource: string, Name or id of the resource for this request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+ # wildcards (such as '*' or 'storage.*') are not allowed.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ # allowed.
+ "A String",
+ ],
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.snapshots.html b/docs/dyn/compute_beta.snapshots.html
index 5ba9709cab..91c28aace4 100644
--- a/docs/dyn/compute_beta.snapshots.html
+++ b/docs/dyn/compute_beta.snapshots.html
@@ -318,7 +318,7 @@ Method Details
# be a dash.
"params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -398,6 +398,9 @@ Method Details
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
+ "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
+ # belongs to.
+ "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to.
"snapshotType": "A String", # Indicates the type of the snapshot.
"sourceDisk": "A String", # The source disk used to create this snapshot.
"sourceDiskEncryptionKey": { # The customer-supplied
@@ -543,10 +546,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
},
],
"warning": { # [Output Only] Informational warning which replaces the list of snapshots
@@ -1028,7 +1027,7 @@ Method Details
# be a dash.
"params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
# as part of resource payload.
- "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have
+ "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
# the same definition as resource
# manager tags. Keys and values can be either in numeric format,
# such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced
@@ -1108,6 +1107,9 @@ Method Details
# 4648 base64 encoded SHA-256 hash of the customer-supplied
# encryption key that protects this resource.
},
+ "snapshotGroupId": "A String", # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
+ # belongs to.
+ "snapshotGroupName": "A String", # Output only. [Output only] The snapshot group that this snapshot belongs to.
"snapshotType": "A String", # Indicates the type of the snapshot.
"sourceDisk": "A String", # The source disk used to create this snapshot.
"sourceDiskEncryptionKey": { # The customer-supplied
@@ -1253,10 +1255,6 @@ Method Details
# multi-regional).
"A String",
],
- "userLicenses": [ # [Output Only] A list of user provided licenses represented by a list of
- # URLs to the license resource.
- "A String",
- ],
}
update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the specified disk with the data included in the request. The update is performed only on selected fields included as part -of update-mask. Only the following fields can be modified: user_license. +of update-mask. Args: project: string, Project ID for this request. (required) @@ -7892,7 +7892,7 @@@@ -543,6 +562,25 @@Method Details
"options": "A String", # Internal use only. "params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced diff --git a/docs/dyn/compute_v1.externalVpnGateways.html b/docs/dyn/compute_v1.externalVpnGateways.html index c81a372213..46e2307004 100644 --- a/docs/dyn/compute_v1.externalVpnGateways.html +++ b/docs/dyn/compute_v1.externalVpnGateways.html @@ -464,6 +464,25 @@Method Details
# character must be a lowercase letter, and all following characters must be # a dash, lowercase letter, or digit, except the last character, which cannot # be a dash. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "redundancyType": "A String", # Indicates the user-supplied redundancy type of this external VPN gateway. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. }
Returns the regionDisks Resource.
+
+ regionHealthAggregationPolicies()
+
Returns the regionHealthAggregationPolicies Resource.
+ diff --git a/docs/dyn/compute_v1.imageFamilyViews.html b/docs/dyn/compute_v1.imageFamilyViews.html index e50fe3ac7f..497df85fd4 100644 --- a/docs/dyn/compute_v1.imageFamilyViews.html +++ b/docs/dyn/compute_v1.imageFamilyViews.html @@ -270,7 +270,7 @@update(project, region, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)
Update the specified disk with the data included in the request. Update is -performed only on selected fields included as part of update-mask. Only the -following fields can be modified: user_license. +performed only on selected fields included as part of update-mask. Args: project: string, Project ID for this request. (required) @@ -6872,7 +6871,7 @@Method Details
"options": "A String", # Internal use only. "params": { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced diff --git a/docs/dyn/compute_v1.regionHealthAggregationPolicies.html b/docs/dyn/compute_v1.regionHealthAggregationPolicies.html new file mode 100644 index 0000000000..a9f7d1ac31 --- /dev/null +++ b/docs/dyn/compute_v1.regionHealthAggregationPolicies.html @@ -0,0 +1,1658 @@ + + + +Compute Engine API . regionHealthAggregationPolicies
+Instance Methods
+ +Retrieves the list of all HealthAggregationPolicy resources,
+ +Retrieves the next page of results.
++
+close()Close httplib2 connections.
++
+delete(project, region, healthAggregationPolicy, requestId=None, x__xgafv=None)Deletes the specified HealthAggregationPolicy in the given region.
++
+get(project, region, healthAggregationPolicy, x__xgafv=None)Returns the specified HealthAggregationPolicy resource in the given region.
++
+insert(project, region, body=None, requestId=None, x__xgafv=None)Create a HealthAggregationPolicy in the specified project in the given
+ +Lists the HealthAggregationPolicies for a project in the given region.
+ +Retrieves the next page of results.
++
+patch(project, region, healthAggregationPolicy, body=None, requestId=None, x__xgafv=None)Updates the specified regional HealthAggregationPolicy
++
+testIamPermissions(project, region, resource, body=None, x__xgafv=None)Returns permissions that a caller has on the specified resource.
+Method Details
+++ +aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)+Retrieves the list of all HealthAggregationPolicy resources, +regional and global, available to the specified project. + +To prevent failure, it is recommended that you set the +`returnPartialSuccess` parameter to `true`. + +Args: + project: string, Name of the project scoping this request. (required) + filter: string, A filter expression that filters resources listed in the response. Most +Compute resources support two types of filter expressions: +expressions that support regular expressions and expressions that follow +API improvement proposal AIP-160. +These two types of filter expressions cannot be mixed in one request. + +If you want to use AIP-160, your expression must specify the field name, an +operator, and the value that you want to use for filtering. The value +must be a string, a number, or a boolean. The operator +must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. + +For example, if you are filtering Compute Engine instances, you can +exclude instances named `example-instance` by specifying +`name != example-instance`. + +The `:*` comparison can be used to test whether a key has been defined. +For example, to find all objects with `owner` label use: +``` +labels.owner:* +``` + +You can also filter nested fields. For example, you could specify +`scheduling.automaticRestart = false` to include instances only +if they are not scheduled for automatic restarts. You can use filtering +on nested fields to filter based onresource labels. + +To filter on multiple expressions, provide each separate expression within +parentheses. For example: +``` +(scheduling.automaticRestart = true) +(cpuPlatform = "Intel Skylake") +``` +By default, each expression is an `AND` expression. However, you +can include `AND` and `OR` expressions explicitly. +For example: +``` +(cpuPlatform = "Intel Skylake") OR +(cpuPlatform = "Intel Broadwell") AND +(scheduling.automaticRestart = true) +``` + +If you want to use a regular expression, use the `eq` (equal) or `ne` +(not equal) operator against a single un-parenthesized expression with or +without quotes or against multiple parenthesized expressions. Examples: + +`fieldname eq unquoted literal` +`fieldname eq 'single quoted literal'` +`fieldname eq "double quoted literal"` +`(fieldname1 eq literal) (fieldname2 ne "literal")` + +The literal value is interpreted as a regular expression using GoogleRE2 library syntax. +The literal value must match the entire field. + +For example, to filter for instances that do not end with name "instance", +you would use `name ne .*instance`. + +You cannot combine constraints on multiple fields using regular +expressions. + includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, +global) should be included in the response. For new resource types added +after this field, the flag has no effect as new resource types will always +include every visible scope for each scope type in response. For resource +types which predate this field, if this flag is omitted or false, only +scopes of the scope types where the resource type is expected to be found +will be included. + maxResults: integer, The maximum number of results per page that should be returned. +If the number of available results is larger than `maxResults`, +Compute Engine returns a `nextPageToken` that can be used to get +the next page of results in subsequent list requests. Acceptable values are +`0` to `500`, inclusive. (Default: `500`) + orderBy: string, Sorts list results by a certain order. By default, results +are returned in alphanumerical order based on the resource name. + +You can also sort results in descending order based on the creation +timestamp using `orderBy="creationTimestamp desc"`. This sorts +results based on the `creationTimestamp` field in +reverse chronological order (newest result first). Use this to sort +resources like operations so that the newest operation is returned first. + +Currently, only sorting by `name` or +`creationTimestamp desc` is supported. + pageToken: string, Specifies a page token to use. Set `pageToken` to the +`nextPageToken` returned by a previous list request to get +the next page of results. + returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case +of failure. The default value is false. + +For example, when partial success behavior is enabled, aggregatedList for a +single zone scope either returns all resources in the zone or no resources, +with an error code. + serviceProjectNumber: string, The Shared VPC service project id or service project number for which +aggregated list request is invoked for subnetworks list-usable api. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Contains a list of HealthAggregationPoliciesScopedList. + "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "items": { # A list of HealthAggregationPoliciesScopedList resources. + "a_key": { # Name of the scope containing this set of HealthAggregationPolicies. + "healthAggregationPolicies": [ # A list of HealthAggregationPolicys contained in this scope. + { # Represents a health aggregation policy. + # + # A health aggregation policy resource defines a policy to aggregate health. + # + # For more information, see + # Health checks overview. + "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 + # text format. + "description": "A String", # An optional description of this resource. Provide this property when you + # create the resource. + "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. + # This field is used in optimistic locking. This field will be ignored when + # inserting a HealthAggregationPolicy. An up-to-date fingerprint + # must be provided in order to patch the HealthAggregationPolicy; Otherwise, + # the request will fail with error 412 conditionNotMet. To see + # the latest fingerprint, make a get() request to retrieve the + # HealthAggregationPolicy. + "healthyPercentThreshold": 42, # Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a + # percentage) of healthy endpoints required in order to consider the + # aggregated health result HEALTHY. Defaults to 60. Must be in + # range [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, + # and will be set to the default if unspecified. Note that both this + # threshold and minHealthyThreshold must be satisfied in order + # for HEALTHY to be the aggregated result. "Endpoints" refers to network + # endpoints within a Network Endpoint Group or instances within an Instance + # Group. + "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. + "kind": "compute#healthAggregationPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation + # policies. + "minHealthyThreshold": 42, # Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of + # healthy endpoints required in order to consider the aggregated health + # result HEALTHY. Defaults to 1. Must be positive. Not + # applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, + # and will be set to the default if unspecified. Note that both this + # threshold and healthyPercentThreshold must be satisfied in + # order for HEALTHY to be the aggregated result. "Endpoints" refers to + # network endpoints within a Network Endpoint Group or instances within an + # Instance Group. + "name": "A String", # Name of the resource. Provided by the client when the resource is created. + # The name must be 1-63 characters long, and comply withRFC1035. + # Specifically, the name must be 1-63 characters long and match the regular + # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first + # character must be a lowercase letter, and all following characters must + # be a dash, lowercase letter, or digit, except the last character, which + # cannot be a dash. + "policyType": "A String", # Specifies the type of the healthAggregationPolicy. The only allowed value + # for global resources is DNS_PUBLIC_IP_POLICY. The only allowed + # value for regional resources is BACKEND_SERVICE_POLICY. Must + # be specified when the healthAggregationPolicy is created, and cannot be + # mutated. + "region": "A String", # Output only. [Output Only] URL of the region where the health aggregation policy + # resides. This field applies only to the regional resource. You must specify + # this field as part of the HTTP request URL. It is not settable as a field + # in the request body. + "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource. + }, + ], + "warning": { # Informational warning which replaces the list of health aggregation + # policies when the list is empty. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, + }, + }, + "kind": "compute#healthAggregationPolicyAggregatedList", # Output only. Type of resource. + "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for + # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for + # the query parameter pageToken in the next list request. + # Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. + "unreachables": [ # Output only. [Output Only] Unreachable resources. + "A String", + ], + "warning": { # [Output Only] Informational warning message. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, +}+++ +aggregatedList_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ +close()+Close httplib2 connections.+++ +delete(project, region, healthAggregationPolicy, requestId=None, x__xgafv=None)+Deletes the specified HealthAggregationPolicy in the given region. + +Args: + project: string, Project ID for this request. (required) + region: string, Name of the region scoping this request. (required) + healthAggregationPolicy: string, Name of the HealthAggregationPolicy resource to delete. (required) + requestId: string, An optional request ID to identify requests. Specify a unique request ID so +that if you must retry your request, the server will know to ignore the +request if it has already been completed. + +For example, consider a situation where you make an initial request and +the request times out. If you make the request again with the same +request ID, the server can check if original operation with the same +request ID was received, and if so, will ignore the second request. This +prevents clients from accidentally creating duplicate commitments. + +The request ID must be +a valid UUID with the exception that zero UUID is not supported +(00000000-0000-0000-0000-000000000000). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents an Operation resource. + # + # Google Compute Engine has three Operation resources: + # + # * [Global](/compute/docs/reference/rest/v1/globalOperations) + # * [Regional](/compute/docs/reference/rest/v1/regionOperations) + # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) + # + # You can use an operation resource to manage asynchronous API requests. + # For more information, readHandling + # API responses. + # + # Operations can be global, regional or zonal. + # + # - For global operations, use the `globalOperations` + # resource. + # - For regional operations, use the + # `regionOperations` resource. + # - For zonal operations, use + # the `zoneOperations` resource. + # + # + # + # For more information, read + # Global, Regional, and Zonal Resources. + # + # Note that completed Operation resources have a limited + # retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. + # Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is + # set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 + # text format. + "error": { # [Output Only] If errors are generated during processing of the operation, + # this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error + # message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error + # status code that was returned. For example, a `404` means the + # resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is + # defined by the server. + "insertTime": "A String", # [Output Only] The time that this operation was requested. + # This value is inRFC3339 + # text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an + # error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information + # if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. + }, + }, + }, + "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for + # Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a + # group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, + # `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. + # There is no requirement that this be linear or support any granularity of + # operations. This should not be used to guess when the operation will be + # complete. This number should monotonically increase as the operation + # progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only + # applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, + # this field will contain information on all underlying zonal actions and + # their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is + # populated. + # different programming environments, including REST APIs and RPC APIs. It is + # used by [gRPC](https://github.com/grpc). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + }, + "state": "A String", # [Output Only] Status of the action, which can be one of the following: + # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + }, + }, + }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. + # This value is inRFC3339 + # text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the + # following: + # `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the + # operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation + # of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For + # operations related to creating a snapshot, this points to the disk + # that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: + # `user@example.com` or + # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the + # operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, + ], + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only + # applicable when performing per-zone operations. +}+++ +get(project, region, healthAggregationPolicy, x__xgafv=None)+Returns the specified HealthAggregationPolicy resource in the given region. + +Args: + project: string, Project ID for this request. (required) + region: string, Name of the region scoping this request. (required) + healthAggregationPolicy: string, Name of the HealthAggregationPolicy resource to return. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents a health aggregation policy. + # + # A health aggregation policy resource defines a policy to aggregate health. + # + # For more information, see + # Health checks overview. + "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 + # text format. + "description": "A String", # An optional description of this resource. Provide this property when you + # create the resource. + "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. + # This field is used in optimistic locking. This field will be ignored when + # inserting a HealthAggregationPolicy. An up-to-date fingerprint + # must be provided in order to patch the HealthAggregationPolicy; Otherwise, + # the request will fail with error 412 conditionNotMet. To see + # the latest fingerprint, make a get() request to retrieve the + # HealthAggregationPolicy. + "healthyPercentThreshold": 42, # Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a + # percentage) of healthy endpoints required in order to consider the + # aggregated health result HEALTHY. Defaults to 60. Must be in + # range [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, + # and will be set to the default if unspecified. Note that both this + # threshold and minHealthyThreshold must be satisfied in order + # for HEALTHY to be the aggregated result. "Endpoints" refers to network + # endpoints within a Network Endpoint Group or instances within an Instance + # Group. + "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. + "kind": "compute#healthAggregationPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation + # policies. + "minHealthyThreshold": 42, # Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of + # healthy endpoints required in order to consider the aggregated health + # result HEALTHY. Defaults to 1. Must be positive. Not + # applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, + # and will be set to the default if unspecified. Note that both this + # threshold and healthyPercentThreshold must be satisfied in + # order for HEALTHY to be the aggregated result. "Endpoints" refers to + # network endpoints within a Network Endpoint Group or instances within an + # Instance Group. + "name": "A String", # Name of the resource. Provided by the client when the resource is created. + # The name must be 1-63 characters long, and comply withRFC1035. + # Specifically, the name must be 1-63 characters long and match the regular + # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first + # character must be a lowercase letter, and all following characters must + # be a dash, lowercase letter, or digit, except the last character, which + # cannot be a dash. + "policyType": "A String", # Specifies the type of the healthAggregationPolicy. The only allowed value + # for global resources is DNS_PUBLIC_IP_POLICY. The only allowed + # value for regional resources is BACKEND_SERVICE_POLICY. Must + # be specified when the healthAggregationPolicy is created, and cannot be + # mutated. + "region": "A String", # Output only. [Output Only] URL of the region where the health aggregation policy + # resides. This field applies only to the regional resource. You must specify + # this field as part of the HTTP request URL. It is not settable as a field + # in the request body. + "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource. +}+++ +insert(project, region, body=None, requestId=None, x__xgafv=None)+Create a HealthAggregationPolicy in the specified project in the given +region using the parameters that are included in the request. + +Args: + project: string, Project ID for this request. (required) + region: string, Name of the region scoping this request. (required) + body: object, The request body. + The object takes the form of: + +{ # Represents a health aggregation policy. + # + # A health aggregation policy resource defines a policy to aggregate health. + # + # For more information, see + # Health checks overview. + "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 + # text format. + "description": "A String", # An optional description of this resource. Provide this property when you + # create the resource. + "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. + # This field is used in optimistic locking. This field will be ignored when + # inserting a HealthAggregationPolicy. An up-to-date fingerprint + # must be provided in order to patch the HealthAggregationPolicy; Otherwise, + # the request will fail with error 412 conditionNotMet. To see + # the latest fingerprint, make a get() request to retrieve the + # HealthAggregationPolicy. + "healthyPercentThreshold": 42, # Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a + # percentage) of healthy endpoints required in order to consider the + # aggregated health result HEALTHY. Defaults to 60. Must be in + # range [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, + # and will be set to the default if unspecified. Note that both this + # threshold and minHealthyThreshold must be satisfied in order + # for HEALTHY to be the aggregated result. "Endpoints" refers to network + # endpoints within a Network Endpoint Group or instances within an Instance + # Group. + "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. + "kind": "compute#healthAggregationPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation + # policies. + "minHealthyThreshold": 42, # Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of + # healthy endpoints required in order to consider the aggregated health + # result HEALTHY. Defaults to 1. Must be positive. Not + # applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, + # and will be set to the default if unspecified. Note that both this + # threshold and healthyPercentThreshold must be satisfied in + # order for HEALTHY to be the aggregated result. "Endpoints" refers to + # network endpoints within a Network Endpoint Group or instances within an + # Instance Group. + "name": "A String", # Name of the resource. Provided by the client when the resource is created. + # The name must be 1-63 characters long, and comply withRFC1035. + # Specifically, the name must be 1-63 characters long and match the regular + # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first + # character must be a lowercase letter, and all following characters must + # be a dash, lowercase letter, or digit, except the last character, which + # cannot be a dash. + "policyType": "A String", # Specifies the type of the healthAggregationPolicy. The only allowed value + # for global resources is DNS_PUBLIC_IP_POLICY. The only allowed + # value for regional resources is BACKEND_SERVICE_POLICY. Must + # be specified when the healthAggregationPolicy is created, and cannot be + # mutated. + "region": "A String", # Output only. [Output Only] URL of the region where the health aggregation policy + # resides. This field applies only to the regional resource. You must specify + # this field as part of the HTTP request URL. It is not settable as a field + # in the request body. + "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource. +} + + requestId: string, An optional request ID to identify requests. Specify a unique request ID so +that if you must retry your request, the server will know to ignore the +request if it has already been completed. + +For example, consider a situation where you make an initial request and +the request times out. If you make the request again with the same +request ID, the server can check if original operation with the same +request ID was received, and if so, will ignore the second request. This +prevents clients from accidentally creating duplicate commitments. + +The request ID must be +a valid UUID with the exception that zero UUID is not supported +(00000000-0000-0000-0000-000000000000). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents an Operation resource. + # + # Google Compute Engine has three Operation resources: + # + # * [Global](/compute/docs/reference/rest/v1/globalOperations) + # * [Regional](/compute/docs/reference/rest/v1/regionOperations) + # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) + # + # You can use an operation resource to manage asynchronous API requests. + # For more information, readHandling + # API responses. + # + # Operations can be global, regional or zonal. + # + # - For global operations, use the `globalOperations` + # resource. + # - For regional operations, use the + # `regionOperations` resource. + # - For zonal operations, use + # the `zoneOperations` resource. + # + # + # + # For more information, read + # Global, Regional, and Zonal Resources. + # + # Note that completed Operation resources have a limited + # retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. + # Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is + # set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 + # text format. + "error": { # [Output Only] If errors are generated during processing of the operation, + # this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error + # message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error + # status code that was returned. For example, a `404` means the + # resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is + # defined by the server. + "insertTime": "A String", # [Output Only] The time that this operation was requested. + # This value is inRFC3339 + # text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an + # error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information + # if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. + }, + }, + }, + "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for + # Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a + # group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, + # `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. + # There is no requirement that this be linear or support any granularity of + # operations. This should not be used to guess when the operation will be + # complete. This number should monotonically increase as the operation + # progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only + # applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, + # this field will contain information on all underlying zonal actions and + # their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is + # populated. + # different programming environments, including REST APIs and RPC APIs. It is + # used by [gRPC](https://github.com/grpc). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + }, + "state": "A String", # [Output Only] Status of the action, which can be one of the following: + # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + }, + }, + }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. + # This value is inRFC3339 + # text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the + # following: + # `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the + # operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation + # of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For + # operations related to creating a snapshot, this points to the disk + # that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: + # `user@example.com` or + # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the + # operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, + ], + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only + # applicable when performing per-zone operations. +}+++ +list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)+Lists the HealthAggregationPolicies for a project in the given region. + +Args: + project: string, Project ID for this request. (required) + region: string, Name of the region scoping this request. (required) + filter: string, A filter expression that filters resources listed in the response. Most +Compute resources support two types of filter expressions: +expressions that support regular expressions and expressions that follow +API improvement proposal AIP-160. +These two types of filter expressions cannot be mixed in one request. + +If you want to use AIP-160, your expression must specify the field name, an +operator, and the value that you want to use for filtering. The value +must be a string, a number, or a boolean. The operator +must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. + +For example, if you are filtering Compute Engine instances, you can +exclude instances named `example-instance` by specifying +`name != example-instance`. + +The `:*` comparison can be used to test whether a key has been defined. +For example, to find all objects with `owner` label use: +``` +labels.owner:* +``` + +You can also filter nested fields. For example, you could specify +`scheduling.automaticRestart = false` to include instances only +if they are not scheduled for automatic restarts. You can use filtering +on nested fields to filter based onresource labels. + +To filter on multiple expressions, provide each separate expression within +parentheses. For example: +``` +(scheduling.automaticRestart = true) +(cpuPlatform = "Intel Skylake") +``` +By default, each expression is an `AND` expression. However, you +can include `AND` and `OR` expressions explicitly. +For example: +``` +(cpuPlatform = "Intel Skylake") OR +(cpuPlatform = "Intel Broadwell") AND +(scheduling.automaticRestart = true) +``` + +If you want to use a regular expression, use the `eq` (equal) or `ne` +(not equal) operator against a single un-parenthesized expression with or +without quotes or against multiple parenthesized expressions. Examples: + +`fieldname eq unquoted literal` +`fieldname eq 'single quoted literal'` +`fieldname eq "double quoted literal"` +`(fieldname1 eq literal) (fieldname2 ne "literal")` + +The literal value is interpreted as a regular expression using GoogleRE2 library syntax. +The literal value must match the entire field. + +For example, to filter for instances that do not end with name "instance", +you would use `name ne .*instance`. + +You cannot combine constraints on multiple fields using regular +expressions. + maxResults: integer, The maximum number of results per page that should be returned. +If the number of available results is larger than `maxResults`, +Compute Engine returns a `nextPageToken` that can be used to get +the next page of results in subsequent list requests. Acceptable values are +`0` to `500`, inclusive. (Default: `500`) + orderBy: string, Sorts list results by a certain order. By default, results +are returned in alphanumerical order based on the resource name. + +You can also sort results in descending order based on the creation +timestamp using `orderBy="creationTimestamp desc"`. This sorts +results based on the `creationTimestamp` field in +reverse chronological order (newest result first). Use this to sort +resources like operations so that the newest operation is returned first. + +Currently, only sorting by `name` or +`creationTimestamp desc` is supported. + pageToken: string, Specifies a page token to use. Set `pageToken` to the +`nextPageToken` returned by a previous list request to get +the next page of results. + returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case +of failure. The default value is false. + +For example, when partial success behavior is enabled, aggregatedList for a +single zone scope either returns all resources in the zone or no resources, +with an error code. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { + "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. + "items": [ # A list of HealthAggregationPolicy resources. + { # Represents a health aggregation policy. + # + # A health aggregation policy resource defines a policy to aggregate health. + # + # For more information, see + # Health checks overview. + "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 + # text format. + "description": "A String", # An optional description of this resource. Provide this property when you + # create the resource. + "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. + # This field is used in optimistic locking. This field will be ignored when + # inserting a HealthAggregationPolicy. An up-to-date fingerprint + # must be provided in order to patch the HealthAggregationPolicy; Otherwise, + # the request will fail with error 412 conditionNotMet. To see + # the latest fingerprint, make a get() request to retrieve the + # HealthAggregationPolicy. + "healthyPercentThreshold": 42, # Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a + # percentage) of healthy endpoints required in order to consider the + # aggregated health result HEALTHY. Defaults to 60. Must be in + # range [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, + # and will be set to the default if unspecified. Note that both this + # threshold and minHealthyThreshold must be satisfied in order + # for HEALTHY to be the aggregated result. "Endpoints" refers to network + # endpoints within a Network Endpoint Group or instances within an Instance + # Group. + "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. + "kind": "compute#healthAggregationPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation + # policies. + "minHealthyThreshold": 42, # Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of + # healthy endpoints required in order to consider the aggregated health + # result HEALTHY. Defaults to 1. Must be positive. Not + # applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, + # and will be set to the default if unspecified. Note that both this + # threshold and healthyPercentThreshold must be satisfied in + # order for HEALTHY to be the aggregated result. "Endpoints" refers to + # network endpoints within a Network Endpoint Group or instances within an + # Instance Group. + "name": "A String", # Name of the resource. Provided by the client when the resource is created. + # The name must be 1-63 characters long, and comply withRFC1035. + # Specifically, the name must be 1-63 characters long and match the regular + # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first + # character must be a lowercase letter, and all following characters must + # be a dash, lowercase letter, or digit, except the last character, which + # cannot be a dash. + "policyType": "A String", # Specifies the type of the healthAggregationPolicy. The only allowed value + # for global resources is DNS_PUBLIC_IP_POLICY. The only allowed + # value for regional resources is BACKEND_SERVICE_POLICY. Must + # be specified when the healthAggregationPolicy is created, and cannot be + # mutated. + "region": "A String", # Output only. [Output Only] URL of the region where the health aggregation policy + # resides. This field applies only to the regional resource. You must specify + # this field as part of the HTTP request URL. It is not settable as a field + # in the request body. + "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource. + }, + ], + "kind": "compute#healthAggregationPolicyList", # Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation + # policies. + "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for + # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for + # the query parameter pageToken in the next list request. + # Subsequent list requests will have their own nextPageToken to + # continue paging through the results. + "selfLink": "A String", # [Output Only] Server-defined URL for this resource. + "warning": { # [Output Only] Informational warning message. + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ +patch(project, region, healthAggregationPolicy, body=None, requestId=None, x__xgafv=None)+Updates the specified regional HealthAggregationPolicy +resource with the data included in the request. This method supportsPATCH +semantics and uses theJSON merge +patch format and processing rules. + +Args: + project: string, Project ID for this request. (required) + region: string, Name of the region scoping this request. (required) + healthAggregationPolicy: string, Name of the HealthAggregationPolicy to update. The name +must be 1-63 characters long, and comply with RFC1035. (required) + body: object, The request body. + The object takes the form of: + +{ # Represents a health aggregation policy. + # + # A health aggregation policy resource defines a policy to aggregate health. + # + # For more information, see + # Health checks overview. + "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 + # text format. + "description": "A String", # An optional description of this resource. Provide this property when you + # create the resource. + "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. + # This field is used in optimistic locking. This field will be ignored when + # inserting a HealthAggregationPolicy. An up-to-date fingerprint + # must be provided in order to patch the HealthAggregationPolicy; Otherwise, + # the request will fail with error 412 conditionNotMet. To see + # the latest fingerprint, make a get() request to retrieve the + # HealthAggregationPolicy. + "healthyPercentThreshold": 42, # Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a + # percentage) of healthy endpoints required in order to consider the + # aggregated health result HEALTHY. Defaults to 60. Must be in + # range [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, + # and will be set to the default if unspecified. Note that both this + # threshold and minHealthyThreshold must be satisfied in order + # for HEALTHY to be the aggregated result. "Endpoints" refers to network + # endpoints within a Network Endpoint Group or instances within an Instance + # Group. + "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. + "kind": "compute#healthAggregationPolicy", # Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation + # policies. + "minHealthyThreshold": 42, # Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of + # healthy endpoints required in order to consider the aggregated health + # result HEALTHY. Defaults to 1. Must be positive. Not + # applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, + # and will be set to the default if unspecified. Note that both this + # threshold and healthyPercentThreshold must be satisfied in + # order for HEALTHY to be the aggregated result. "Endpoints" refers to + # network endpoints within a Network Endpoint Group or instances within an + # Instance Group. + "name": "A String", # Name of the resource. Provided by the client when the resource is created. + # The name must be 1-63 characters long, and comply withRFC1035. + # Specifically, the name must be 1-63 characters long and match the regular + # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first + # character must be a lowercase letter, and all following characters must + # be a dash, lowercase letter, or digit, except the last character, which + # cannot be a dash. + "policyType": "A String", # Specifies the type of the healthAggregationPolicy. The only allowed value + # for global resources is DNS_PUBLIC_IP_POLICY. The only allowed + # value for regional resources is BACKEND_SERVICE_POLICY. Must + # be specified when the healthAggregationPolicy is created, and cannot be + # mutated. + "region": "A String", # Output only. [Output Only] URL of the region where the health aggregation policy + # resides. This field applies only to the regional resource. You must specify + # this field as part of the HTTP request URL. It is not settable as a field + # in the request body. + "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL with id for the resource. +} + + requestId: string, An optional request ID to identify requests. Specify a unique request ID so +that if you must retry your request, the server will know to ignore the +request if it has already been completed. + +For example, consider a situation where you make an initial request and +the request times out. If you make the request again with the same +request ID, the server can check if original operation with the same +request ID was received, and if so, will ignore the second request. This +prevents clients from accidentally creating duplicate commitments. + +The request ID must be +a valid UUID with the exception that zero UUID is not supported +(00000000-0000-0000-0000-000000000000). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents an Operation resource. + # + # Google Compute Engine has three Operation resources: + # + # * [Global](/compute/docs/reference/rest/v1/globalOperations) + # * [Regional](/compute/docs/reference/rest/v1/regionOperations) + # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) + # + # You can use an operation resource to manage asynchronous API requests. + # For more information, readHandling + # API responses. + # + # Operations can be global, regional or zonal. + # + # - For global operations, use the `globalOperations` + # resource. + # - For regional operations, use the + # `regionOperations` resource. + # - For zonal operations, use + # the `zoneOperations` resource. + # + # + # + # For more information, read + # Global, Regional, and Zonal Resources. + # + # Note that completed Operation resources have a limited + # retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. + # Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is + # set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 + # text format. + "error": { # [Output Only] If errors are generated during processing of the operation, + # this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error + # message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error + # status code that was returned. For example, a `404` means the + # resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is + # defined by the server. + "insertTime": "A String", # [Output Only] The time that this operation was requested. + # This value is inRFC3339 + # text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an + # error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information + # if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. + }, + }, + }, + "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for + # Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a + # group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, + # `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. + # There is no requirement that this be linear or support any granularity of + # operations. This should not be used to guess when the operation will be + # complete. This number should monotonically increase as the operation + # progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only + # applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, + # this field will contain information on all underlying zonal actions and + # their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is + # populated. + # different programming environments, including REST APIs and RPC APIs. It is + # used by [gRPC](https://github.com/grpc). Each `Status` message contains + # three pieces of data: error code, error message, and error details. + # + # You can find out more about this error model and how to work with it in the + # [API Design Guide](https://cloud.google.com/apis/design/errors). + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any + # user-facing error message should be localized and sent in the + # google.rpc.Status.details field, or localized by the client. + }, + "state": "A String", # [Output Only] Status of the action, which can be one of the following: + # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + }, + }, + }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. + # This value is inRFC3339 + # text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the + # following: + # `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the + # operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation + # of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For + # operations related to creating a snapshot, this points to the disk + # that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: + # `user@example.com` or + # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the + # operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, + ], + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only + # applicable when performing per-zone operations. +}+++ + \ No newline at end of file diff --git a/docs/dyn/compute_v1.regionInstanceTemplates.html b/docs/dyn/compute_v1.regionInstanceTemplates.html index 13154466e7..bf988ed429 100644 --- a/docs/dyn/compute_v1.regionInstanceTemplates.html +++ b/docs/dyn/compute_v1.regionInstanceTemplates.html @@ -661,7 +661,7 @@testIamPermissions(project, region, resource, body=None, x__xgafv=None)+Returns permissions that a caller has on the specified resource. + +Args: + project: string, Project ID for this request. (required) + region: string, The name of the region for this request. (required) + resource: string, Name or id of the resource for this request. (required) + body: object, The request body. + The object takes the form of: + +{ + "permissions": [ # The set of permissions to check for the 'resource'. Permissions with + # wildcards (such as '*' or 'storage.*') are not allowed. + "A String", + ], +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { + "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is + # allowed. + "A String", + ], +}+Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -1151,7 +1151,7 @@Method Details
"A String", ], }, - "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values # have the same definition as resource # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and # values are in the format `tagValues/456`. The field is ignored (both PUT & @@ -1612,7 +1612,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -2102,7 +2102,7 @@Method Details
"A String", ], }, - "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values # have the same definition as resource # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and # values are in the format `tagValues/456`. The field is ignored (both PUT & @@ -2926,7 +2926,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -3416,7 +3416,7 @@Method Details
"A String", ], }, - "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values # have the same definition as resource # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and # values are in the format `tagValues/456`. The field is ignored (both PUT & diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html index f117f8674a..2e56a65519 100644 --- a/docs/dyn/compute_v1.regionInstances.html +++ b/docs/dyn/compute_v1.regionInstances.html @@ -309,7 +309,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -790,7 +790,7 @@Method Details
# as the instance zone. "A String", ], - "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the disk. Tag keys and values # have the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -1280,7 +1280,7 @@Method Details
"A String", ], }, - "resourceManagerTags": { # Resource manager tags to be bound to the instance. Tag keys and values + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the instance. Tag keys and values # have the same definition as resource # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and # values are in the format `tagValues/456`. The field is ignored (both PUT & @@ -1423,6 +1423,13 @@Method Details
"locations": { # Location configurations mapped by location name. # Currently only zone names are supported and must be represented as valid # internal URLs, such as zones/us-central1-a. + # The bulkInsert operation doesn't create instances in an AI zone, even if + # an AI zone is available in the specified region. For example, if you set a + # DENY preference for us-central1-a, Compute Engine will consider + # us-central1-b and us-central1-c for instance creation, but not + # us-central1-ai1a. Also, you can't use the locations[] configuration to + # allow instance creation in an AI zone. To include an AI zone in bulkInsert + # operations, use the locationPolicy.zones[] field. "a_key": { "constraints": { # Per-zone constraints on location policy for this zone. # Constraints that the caller requires on the result distribution # in this zone. @@ -1433,6 +1440,16 @@Method Details
}, }, "targetShape": "A String", # Strategy for distributing VMs across zones in a region. + "zones": [ # The bulkInsert operation applies any preferences set in the locations + # field to the specific zones listed in the zones field if the same zones + # are specified in both fields. + { + "zone": "A String", # The URL of the zone. + # The zone must exist in the region where the request is called. + # Zones must be represented as valid partial URLs, + # such as zones/us-central1-a. + }, + ], }, "minCount": "A String", # The minimum number of instances to create. If no min_count is # specified then count is used as the default value. Ifmin_count instances cannot be created, then no instances will diff --git a/docs/dyn/compute_v1.reservations.html b/docs/dyn/compute_v1.reservations.html index b374a41550..7ac235a2dd 100644 --- a/docs/dyn/compute_v1.reservations.html +++ b/docs/dyn/compute_v1.reservations.html @@ -307,6 +307,18 @@Method Details
# character must be a lowercase letter, and all following characters must be # a dash, lowercase letter, or digit, except the last character, which cannot # be a dash. + "params": { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the reservation. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations # in the event of infrastructure failures at data center (e.g. power # and/or cooling failures). @@ -903,6 +915,18 @@Method Details
# character must be a lowercase letter, and all following characters must be # a dash, lowercase letter, or digit, except the last character, which cannot # be a dash. + "params": { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the reservation. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations # in the event of infrastructure failures at data center (e.g. power # and/or cooling failures). @@ -1498,6 +1522,18 @@Method Details
# character must be a lowercase letter, and all following characters must be # a dash, lowercase letter, or digit, except the last character, which cannot # be a dash. + "params": { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the reservation. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations # in the event of infrastructure failures at data center (e.g. power # and/or cooling failures). @@ -2088,6 +2124,18 @@Method Details
# character must be a lowercase letter, and all following characters must be # a dash, lowercase letter, or digit, except the last character, which cannot # be a dash. + "params": { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the reservation. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations # in the event of infrastructure failures at data center (e.g. power # and/or cooling failures). @@ -3852,6 +3900,18 @@Method Details
# character must be a lowercase letter, and all following characters must be # a dash, lowercase letter, or digit, except the last character, which cannot # be a dash. + "params": { # Additional reservation params. # Input only. Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the reservation. Tag keys and + # values have the same definition as resource + # manager tags. Keys and values can be either in numeric format, + # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in + # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and + # `{tag_value_short_name}`. The field is ignored (both PUT & + # PATCH) when empty. + "a_key": "A String", + }, + }, "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations # in the event of infrastructure failures at data center (e.g. power # and/or cooling failures). diff --git a/docs/dyn/compute_v1.snapshots.html b/docs/dyn/compute_v1.snapshots.html index 567d8ca2d6..b7d049228c 100644 --- a/docs/dyn/compute_v1.snapshots.html +++ b/docs/dyn/compute_v1.snapshots.html @@ -503,7 +503,7 @@Method Details
# be a dash. "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have # the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -1201,7 +1201,7 @@Method Details
# be a dash. "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have # the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced @@ -1891,7 +1891,7 @@Method Details
# be a dash. "params": { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted # as part of resource payload. - "resourceManagerTags": { # Resource manager tags to be bound to the snapshot. Tag keys and values have + "resourceManagerTags": { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have # the same definition as resource # manager tags. Keys and values can be either in numeric format, # such as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced diff --git a/docs/dyn/compute_v1.targetVpnGateways.html b/docs/dyn/compute_v1.targetVpnGateways.html index bc78bc0154..0f66364617 100644 --- a/docs/dyn/compute_v1.targetVpnGateways.html +++ b/docs/dyn/compute_v1.targetVpnGateways.html @@ -255,6 +255,25 @@Method Details
# cannot be a dash. "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the # client when the VPN gateway is created. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. # You must specify this field as part of the HTTP request URL. It is # not settable as a field in the request body. @@ -689,6 +708,25 @@Method Details
# cannot be a dash. "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the # client when the VPN gateway is created. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. # You must specify this field as part of the HTTP request URL. It is # not settable as a field in the request body. @@ -753,6 +791,25 @@Method Details
# cannot be a dash. "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the # client when the VPN gateway is created. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. # You must specify this field as part of the HTTP request URL. It is # not settable as a field in the request body. @@ -1180,6 +1237,25 @@Method Details
# cannot be a dash. "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the # client when the VPN gateway is created. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. # You must specify this field as part of the HTTP request URL. It is # not settable as a field in the request body. diff --git a/docs/dyn/compute_v1.vpnGateways.html b/docs/dyn/compute_v1.vpnGateways.html index c4fe05087e..0f10203370 100644 --- a/docs/dyn/compute_v1.vpnGateways.html +++ b/docs/dyn/compute_v1.vpnGateways.html @@ -261,6 +261,25 @@Method Details
# cannot be a dash. "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the # client when the VPN gateway is created. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "region": "A String", # Output only. [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are @@ -715,6 +734,25 @@Method Details
# cannot be a dash. "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the # client when the VPN gateway is created. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "region": "A String", # Output only. [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are @@ -849,6 +887,25 @@Method Details
# cannot be a dash. "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the # client when the VPN gateway is created. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "region": "A String", # Output only. [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are @@ -1295,6 +1352,25 @@Method Details
# cannot be a dash. "network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the # client when the VPN gateway is created. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "region": "A String", # Output only. [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource. "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are diff --git a/docs/dyn/compute_v1.vpnTunnels.html b/docs/dyn/compute_v1.vpnTunnels.html index 40ad85a87c..5e53dc40f9 100644 --- a/docs/dyn/compute_v1.vpnTunnels.html +++ b/docs/dyn/compute_v1.vpnTunnels.html @@ -287,6 +287,25 @@Method Details
# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is # connected. # Provided by the client when the VPN tunnel is created. @@ -816,6 +835,25 @@Method Details
# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is # connected. # Provided by the client when the VPN tunnel is created. @@ -974,6 +1012,25 @@Method Details
# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is # connected. # Provided by the client when the VPN tunnel is created. @@ -1495,6 +1552,25 @@Method Details
# character must be a lowercase letter, and all following characters must # be a dash, lowercase letter, or digit, except the last character, which # cannot be a dash. + "params": { # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # Tag keys and values have the same definition as resource + # manager tags. The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is # connected. # Provided by the client when the VPN tunnel is created. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.dashboards.html b/docs/dyn/contactcenterinsights_v1.projects.locations.dashboards.html index 1b5a92a4fc..99390523df 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.dashboards.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.dashboards.html @@ -785,7 +785,7 @@Method Details
"updateTime": "A String", # Output only. Dashboard last update time. } - updateMask: string, Optional. List of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name` * `root_container` + updateMask: string, Optional. List of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name` * `root_container` * `description` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html b/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html index a1ab20e9d2..37270b074f 100644 --- a/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html @@ -796,6 +796,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -910,6 +911,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], diff --git a/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html b/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html index 8b2c508247..bfdbea0a26 100644 --- a/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html @@ -812,6 +812,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -926,6 +927,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1699,6 +1701,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1813,6 +1816,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -2591,6 +2595,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -2705,6 +2710,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -3474,6 +3480,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -3588,6 +3595,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -4382,6 +4390,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -4496,6 +4505,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -5659,6 +5669,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -5773,6 +5784,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -6563,6 +6575,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -6677,6 +6690,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -7447,6 +7461,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -7561,6 +7576,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], diff --git a/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html index c2ffedee09..f092b18775 100644 --- a/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.notes.occurrences.html @@ -796,6 +796,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -910,6 +911,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], diff --git a/docs/dyn/containeranalysis_v1.projects.occurrences.html b/docs/dyn/containeranalysis_v1.projects.occurrences.html index 07df20237f..5dcd5e3673 100644 --- a/docs/dyn/containeranalysis_v1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1.projects.occurrences.html @@ -812,6 +812,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -926,6 +927,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1699,6 +1701,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1813,6 +1816,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -2591,6 +2595,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -2705,6 +2710,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -3474,6 +3480,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -3588,6 +3595,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -4382,6 +4390,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -4496,6 +4505,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -5659,6 +5669,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -5773,6 +5784,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -6563,6 +6575,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -6677,6 +6690,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -7447,6 +7461,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -7561,6 +7576,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry in which the base image is from. "repository": "A String", # The repository name in which the base image is from. }, ], diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html index 785641febf..0ff12c6c69 100644 --- a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html +++ b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html @@ -390,6 +390,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -711,6 +712,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1055,6 +1057,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1431,6 +1434,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1768,6 +1772,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -2088,6 +2093,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html index 8398d953bf..0a3eb5c4b4 100644 --- a/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1alpha1.projects.notes.occurrences.html @@ -851,6 +851,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -974,6 +975,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1004,6 +1006,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html index ad0b2f1b6e..0b594f7d61 100644 --- a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html +++ b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html @@ -867,6 +867,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -990,6 +991,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1020,6 +1022,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1837,6 +1840,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1960,6 +1964,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1990,6 +1995,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -2831,6 +2837,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -2954,6 +2961,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -2984,6 +2992,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -3374,6 +3383,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -4228,6 +4238,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -4351,6 +4362,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -4381,6 +4393,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -5215,6 +5228,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -5338,6 +5352,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -5368,6 +5383,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -6185,6 +6201,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -6308,6 +6325,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -6338,6 +6356,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], diff --git a/docs/dyn/containeranalysis_v1alpha1.providers.notes.html b/docs/dyn/containeranalysis_v1alpha1.providers.notes.html index 4e8c203771..4ae9d77802 100644 --- a/docs/dyn/containeranalysis_v1alpha1.providers.notes.html +++ b/docs/dyn/containeranalysis_v1alpha1.providers.notes.html @@ -390,6 +390,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -711,6 +712,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1055,6 +1057,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1431,6 +1434,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1768,6 +1772,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -2088,6 +2093,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], diff --git a/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html index 9496b4605f..2c6453d81b 100644 --- a/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html +++ b/docs/dyn/containeranalysis_v1alpha1.providers.notes.occurrences.html @@ -851,6 +851,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -974,6 +975,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], @@ -1004,6 +1006,7 @@Method Details
{ # BaseImage describes a base image of a container image. "layerCount": 42, # The number of layers that the base image is composed of. "name": "A String", # The name of the base image. + "registry": "A String", # The registry of the base image. "repository": "A String", # The repository name in which the base image is from. }, ], diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html index 53c9a795a6..a821a883fc 100644 --- a/docs/dyn/dataflow_v1b3.projects.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.jobs.html @@ -214,6 +214,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -579,6 +581,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -928,6 +932,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -1284,6 +1290,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -1700,6 +1708,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -2106,6 +2116,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -2449,6 +2461,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html index 9aaa627862..3ae321c66c 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html @@ -296,6 +296,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html index 0a28f0f207..015e43de62 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html @@ -202,6 +202,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -550,6 +552,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -906,6 +910,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -1432,6 +1438,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -1840,6 +1848,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -2182,6 +2192,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.templates.html b/docs/dyn/dataflow_v1b3.projects.locations.templates.html index 78160f9b1e..ff21ad63f0 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.templates.html @@ -203,6 +203,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -704,6 +706,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. diff --git a/docs/dyn/dataflow_v1b3.projects.templates.html b/docs/dyn/dataflow_v1b3.projects.templates.html index 0d077f9482..e921a1cfee 100644 --- a/docs/dyn/dataflow_v1b3.projects.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.templates.html @@ -202,6 +202,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. @@ -703,6 +705,8 @@Method Details
}, ], "defaultPackageSet": "A String", # The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language. + "diskProvisionedIops": "A String", # Optional. IOPS provisioned for the root disk for VMs. + "diskProvisionedThroughputMibps": "A String", # Optional. Throughput provisioned for the root disk for VMs. "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. "diskSourceImage": "A String", # Fully qualified source image for disks. "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. diff --git a/docs/dyn/dataform_v1.projects.locations.html b/docs/dyn/dataform_v1.projects.locations.html index d59a59546e..5178f60e2b 100644 --- a/docs/dyn/dataform_v1.projects.locations.html +++ b/docs/dyn/dataform_v1.projects.locations.html @@ -105,7 +105,7 @@Instance Methods
Get default config for a given project and location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -168,7 +168,7 @@Method Details
@@ -1129,6 +1132,7 @@list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. +Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.compilationResults.html b/docs/dyn/dataform_v1.projects.locations.repositories.compilationResults.html index c2dcb1a6ab..a9747f1511 100644 --- a/docs/dyn/dataform_v1.projects.locations.repositories.compilationResults.html +++ b/docs/dyn/dataform_v1.projects.locations.repositories.compilationResults.html @@ -533,7 +533,7 @@Method Details
"clusterExpressions": [ # A list of columns or SQL expressions used to cluster the table. "A String", ], - "connection": "A String", # Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}", or be set to DEFAULT. + "connection": "A String", # Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}`, or be set to DEFAULT. "dependencyTargets": [ # A list of actions that this action depends on. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. "database": "A String", # Optional. The action's database (Google Cloud project ID) . diff --git a/docs/dyn/dataform_v1beta1.projects.locations.folders.html b/docs/dyn/dataform_v1beta1.projects.locations.folders.html index 598f4399f5..9625ba01cc 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.folders.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.folders.html @@ -243,7 +243,7 @@Method Details
The object takes the form of: { # `MoveFolder` request message. - "destinationContainingFolder": "A String", # Required. The name of the Folder, TeamFolder, or root location to move the Folder to. Can be in the format of: - "" to move into the root User folder - `projects/*/locations/*/folders/*` - `projects/*/locations/*/teamFolders/*` + "destinationContainingFolder": "A String", # Optional. The name of the Folder, TeamFolder, or root location to move the Folder to. Can be in the format of: "" to move into the root User folder, `projects/*/locations/*/folders/*`, `projects/*/locations/*/teamFolders/*` } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dataform_v1beta1.projects.locations.html b/docs/dyn/dataform_v1beta1.projects.locations.html index 99603daf6e..18ddd7d593 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.html @@ -105,7 +105,7 @@Instance Methods
Get default config for a given project and location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -174,7 +174,7 @@Method Details
+list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. +Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. Args: name: string, The resource that owns the locations collection, if applicable. (required) diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html index c1cb98a1ba..1ca41c1774 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.compilationResults.html @@ -533,7 +533,7 @@Method Details
"clusterExpressions": [ # A list of columns or SQL expressions used to cluster the table. "A String", ], - "connection": "A String", # Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}", or be set to DEFAULT. + "connection": "A String", # Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}`, or be set to DEFAULT. "dependencyTargets": [ # A list of actions that this action depends on. { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. "database": "A String", # Optional. The action's database (Google Cloud project ID) . diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html index 4661d417c5..dc87128e0e 100644 --- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html +++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html @@ -565,7 +565,7 @@Method Details
The object takes the form of: { # `MoveRepository` request message. - "destinationContainingFolder": "A String", # Required. The name of the Folder, TeamFolder, or root location to move the repository to. Can be in the format of: - "" to move into the root User folder - `projects/*/locations/*/folders/*` - `projects/*/locations/*/teamFolders/*` + "destinationContainingFolder": "A String", # Optional. The name of the Folder, TeamFolder, or root location to move the repository to. Can be in the format of: "" to move into the root User folder, `projects/*/locations/*/folders/*`, `projects/*/locations/*/teamFolders/*` } x__xgafv: string, V1 error format. diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.html b/docs/dyn/datamanager_v1.accountTypes.accounts.html new file mode 100644 index 0000000000..7064b848b9 --- /dev/null +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.html @@ -0,0 +1,111 @@ + + + +Data Manager API . accountTypes . accounts
+Instance Methods
++
+insights()+Returns the insights Resource.
+ ++
+partnerLinks()+Returns the partnerLinks Resource.
+ + +Returns the userListDirectLicenses Resource.
+ + +Returns the userListGlobalLicenses Resource.
+ ++
+userLists()+Returns the userLists Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.insights.html b/docs/dyn/datamanager_v1.accountTypes.accounts.insights.html new file mode 100644 index 0000000000..0009595cef --- /dev/null +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.insights.html @@ -0,0 +1,135 @@ + + + +close()+Close httplib2 connections.+Data Manager API . accountTypes . accounts . insights
+Instance Methods
++
+close()Close httplib2 connections.
++
+retrieve(parent, body=None, x__xgafv=None)Retrieves marketing data insights for a given user list. This feature is only available to data partners. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html b/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html new file mode 100644 index 0000000000..0fda4012bd --- /dev/null +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html @@ -0,0 +1,216 @@ + + + +retrieve(parent, body=None, x__xgafv=None)+Retrieves marketing data insights for a given user list. This feature is only available to data partners. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}` + +Args: + parent: string, Required. The parent account that owns the user list. Format: `accountTypes/{account_type}/accounts/{account}` (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for DM API MarketingDataInsightsService.RetrieveInsights + "baseline": { # Baseline criteria against which insights are compared. # Required. Baseline for the insights requested. + "baselineLocation": { # The baseline location of the request. Baseline location is on OR-list of ISO 3166-1 alpha-2 region codes of the requested regions. # The baseline location of the request. Baseline location is an OR-list of the requested regions. + "regionCodes": [ # List of ISO 3166-1 alpha-2 region codes. + "A String", + ], + }, + "locationAutoDetectionEnabled": True or False, # If set to true, the service will try to automatically detect the baseline location for insights. + }, + "userListId": "A String", # Required. The user list ID for which insights are requested. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message for DM API MarketingDataInsightsService.RetrieveInsights + "marketingDataInsights": [ # Contains the insights for the marketing data. + { # Insights for marketing data. This feature is only available to data partners. + "attributes": [ # Insights for values of a given dimension. + { # Insights for a collection of related attributes of the same dimension. + "ageRange": "A String", # Age range of the audience for which the lift is provided. + "gender": "A String", # Gender of the audience for which the lift is provided. + "lift": 3.14, # Measure of lift that the audience has for the attribute value as compared to the baseline. Range [0-1]. + "userInterestId": "A String", # The user interest ID. + }, + ], + "dimension": "A String", # The dimension to which the insight belongs. + }, + ], +}+Data Manager API . accountTypes . accounts . partnerLinks
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Creates a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
+ +Deletes a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
++
+search(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Searches for all partner links to and from a given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
+ +Retrieves the next page of results.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, x__xgafv=None)+Creates a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}` + +Args: + parent: string, Required. The parent, which owns this collection of partner links. Format: accountTypes/{account_type}/accounts/{account} (required) + body: object, The request body. + The object takes the form of: + +{ # A partner link between an owning account and a partner account. + "name": "A String", # Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} + "owningAccount": { # Represents a specific account. # Required. The owning account granting access to the partner account. + "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID. + "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match. + "product": "A String", # Deprecated. Use `account_type` instead. + }, + "partnerAccount": { # Represents a specific account. # Required. The partner account granted access by the owning account. + "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID. + "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match. + "product": "A String", # Deprecated. Use `account_type` instead. + }, + "partnerLinkId": "A String", # Output only. The partner link ID. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A partner link between an owning account and a partner account. + "name": "A String", # Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} + "owningAccount": { # Represents a specific account. # Required. The owning account granting access to the partner account. + "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID. + "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match. + "product": "A String", # Deprecated. Use `account_type` instead. + }, + "partnerAccount": { # Represents a specific account. # Required. The partner account granted access by the owning account. + "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID. + "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match. + "product": "A String", # Deprecated. Use `account_type` instead. + }, + "partnerLinkId": "A String", # Output only. The partner link ID. +}+++ +delete(name, x__xgafv=None)+Deletes a partner link for the given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}` + +Args: + name: string, Required. The resource name of the partner link to delete. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } +}+++ +search(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+Searches for all partner links to and from a given account. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}` + +Args: + parent: string, Required. Account to search for partner links. If no `filter` is specified, all partner links where this account is either the `owning_account` or `partner_account` are returned. Format: `accountTypes/{account_type}/accounts/{account}` (required) + filter: string, Optional. A [filter string](//google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" OR partner_account.account_id = 987654321` + pageSize: integer, The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100. + pageToken: string, A page token, received from a previous `SearchPartnerLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchPartnerLinks` must match the call that provided the page token. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response from the SearchPartnerLinksRequest. + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "partnerLinks": [ # The partner links for the given account. + { # A partner link between an owning account and a partner account. + "name": "A String", # Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link} + "owningAccount": { # Represents a specific account. # Required. The owning account granting access to the partner account. + "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID. + "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match. + "product": "A String", # Deprecated. Use `account_type` instead. + }, + "partnerAccount": { # Represents a specific account. # Required. The partner account granted access by the owning account. + "accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID. + "accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match. + "product": "A String", # Deprecated. Use `account_type` instead. + }, + "partnerLinkId": "A String", # Output only. The partner link ID. + }, + ], +}+++ + \ No newline at end of file diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html new file mode 100644 index 0000000000..08cd5168d1 --- /dev/null +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html @@ -0,0 +1,436 @@ + + + +search_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++Data Manager API . accountTypes . accounts . userListDirectLicenses
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Creates a user list direct license. This feature is only available to data partners.
+ +Retrieves a user list direct license. This feature is only available to data partners.
++
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists all user list direct licenses owned by the parent account. This feature is only available to data partners.
+ +Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, x__xgafv=None)Updates a user list direct license. This feature is only available to data partners.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, x__xgafv=None)+Creates a user list direct license. This feature is only available to data partners. + +Args: + parent: string, Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required) + body: object, The request body. + The object takes the form of: + +{ # A user list direct license. This feature is only available to data partners. + "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only. + "clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to. + "clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to. + "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list direct license. + "pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. + "userListId": "A String", # Immutable. ID of the user list being licensed. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A user list direct license. This feature is only available to data partners. + "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only. + "clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to. + "clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to. + "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list direct license. + "pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. + "userListId": "A String", # Immutable. ID of the user list being licensed. +}+++ +get(name, x__xgafv=None)+Retrieves a user list direct license. This feature is only available to data partners. + +Args: + name: string, Required. The resource name of the user list direct license. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A user list direct license. This feature is only available to data partners. + "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only. + "clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to. + "clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to. + "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list direct license. + "pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. + "userListId": "A String", # Immutable. ID of the user list being licensed. +}+++ +list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+Lists all user list direct licenses owned by the parent account. This feature is only available to data partners. + +Args: + parent: string, Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required) + filter: string, Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` + pageSize: integer, Optional. The maximum number of licenses to return per page. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + pageToken: string, Optional. A page token, received from a previous `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response from the ListUserListDirectLicensesRequest. + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "userListDirectLicenses": [ # The licenses for the given user list in the request. + { # A user list direct license. This feature is only available to data partners. + "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only. + "clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to. + "clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to. + "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list direct license. + "pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. + "userListId": "A String", # Immutable. ID of the user list being licensed. + }, + ], +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ + \ No newline at end of file diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html new file mode 100644 index 0000000000..9dfc358377 --- /dev/null +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html @@ -0,0 +1,429 @@ + + + +patch(name, body=None, updateMask=None, x__xgafv=None)+Updates a user list direct license. This feature is only available to data partners. + +Args: + name: string, Identifier. The resource name of the user list direct license. (required) + body: object, The request body. + The object takes the form of: + +{ # A user list direct license. This feature is only available to data partners. + "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only. + "clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to. + "clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to. + "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list direct license. + "pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. + "userListId": "A String", # Immutable. ID of the user list being licensed. +} + + updateMask: string, Optional. The list of fields to update. The special character `*` is not supported and an `INVALID_UPDATE_MASK` error will be thrown if used. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A user list direct license. This feature is only available to data partners. + "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. This field is read-only. + "clientAccountId": "A String", # Immutable. ID of client customer which the user list is being licensed to. + "clientAccountType": "A String", # Immutable. Account type of client customer which the user list is being licensed to. + "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list direct license. + "pricing": { # A user list license pricing. # Optional. UserListDirectLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Optional. Status of UserListDirectLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. + "userListId": "A String", # Immutable. ID of the user list being licensed. +}+Data Manager API . accountTypes . accounts . userListGlobalLicenses
+Instance Methods
++
+userListGlobalLicenseCustomerInfos()+Returns the userListGlobalLicenseCustomerInfos Resource.
+ ++
+close()Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Creates a user list global license. This feature is only available to data partners.
+ +Retrieves a user list global license. This feature is only available to data partners.
++
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists all user list global licenses owned by the parent account. This feature is only available to data partners.
+ +Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, x__xgafv=None)Updates a user list global license. This feature is only available to data partners.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, x__xgafv=None)+Creates a user list global license. This feature is only available to data partners. + +Args: + parent: string, Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required) + body: object, The request body. + The object takes the form of: + +{ # A user list global license. This feature is only available to data partners. + "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "licenseType": "A String", # Immutable. Product type of client customer which the user list is being licensed to. + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list global license. + "pricing": { # A user list license pricing. # Optional. UserListGlobalLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. + "userListId": "A String", # Immutable. ID of the user list being licensed. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A user list global license. This feature is only available to data partners. + "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "licenseType": "A String", # Immutable. Product type of client customer which the user list is being licensed to. + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list global license. + "pricing": { # A user list license pricing. # Optional. UserListGlobalLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. + "userListId": "A String", # Immutable. ID of the user list being licensed. +}+++ +get(name, x__xgafv=None)+Retrieves a user list global license. This feature is only available to data partners. + +Args: + name: string, Required. The resource name of the user list global license. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A user list global license. This feature is only available to data partners. + "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "licenseType": "A String", # Immutable. Product type of client customer which the user list is being licensed to. + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list global license. + "pricing": { # A user list license pricing. # Optional. UserListGlobalLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. + "userListId": "A String", # Immutable. ID of the user list being licensed. +}+++ +list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+Lists all user list global licenses owned by the parent account. This feature is only available to data partners. + +Args: + parent: string, Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required) + filter: string, Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` + pageSize: integer, Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + pageToken: string, Optional. A page token, received from a previous `ListUserListGlobalLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response from the ListUserListGlobalLicensesRequest. + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "userListGlobalLicenses": [ # The licenses for the given user list in the request. + { # A user list global license. This feature is only available to data partners. + "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "licenseType": "A String", # Immutable. Product type of client customer which the user list is being licensed to. + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list global license. + "pricing": { # A user list license pricing. # Optional. UserListGlobalLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. + "userListId": "A String", # Immutable. ID of the user list being licensed. + }, + ], +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ + \ No newline at end of file diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html new file mode 100644 index 0000000000..7c4e873ff5 --- /dev/null +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html @@ -0,0 +1,171 @@ + + + +patch(name, body=None, updateMask=None, x__xgafv=None)+Updates a user list global license. This feature is only available to data partners. + +Args: + name: string, Identifier. The resource name of the user list global license. (required) + body: object, The request body. + The object takes the form of: + +{ # A user list global license. This feature is only available to data partners. + "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "licenseType": "A String", # Immutable. Product type of client customer which the user list is being licensed to. + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list global license. + "pricing": { # A user list license pricing. # Optional. UserListGlobalLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. + "userListId": "A String", # Immutable. ID of the user list being licensed. +} + + updateMask: string, Optional. The list of fields to update. The special character `*` is not supported and an `INVALID_UPDATE_MASK` error will be thrown if used. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A user list global license. This feature is only available to data partners. + "historicalPricings": [ # Output only. Pricing history of this user list license. This field is read-only. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "licenseType": "A String", # Immutable. Product type of client customer which the user list is being licensed to. + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list global license. + "pricing": { # A user list license pricing. # Optional. UserListGlobalLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. This field is read-only. + "userListId": "A String", # Immutable. ID of the user list being licensed. +}+Data Manager API . accountTypes . accounts . userListGlobalLicenses . userListGlobalLicenseCustomerInfos
+Instance Methods
++
+close()Close httplib2 connections.
++
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists all customer info for a user list global license. This feature is only available to data partners.
+ +Retrieves the next page of results.
+Method Details
+++ +close()+Close httplib2 connections.+++ +list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+Lists all customer info for a user list global license. This feature is only available to data partners. + +Args: + parent: string, Required. The global license whose customer info are being queried. Should be in the format `accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}`. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, `accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-`) (required) + filter: string, Optional. Filters to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` + pageSize: integer, Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + pageToken: string, Optional. A page token, received from a previous `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response from the ListUserListGlobalLicensesCustomerInfoRequest. + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "userListGlobalLicenseCustomerInfos": [ # The customer information for the given license in the request. + { # Information about a customer of a user list global license. This will automatically be created by the system when a customer purchases a global license. + "clientAccountDisplayName": "A String", # Output only. Name of client customer which the user list is being licensed to. + "clientAccountId": "A String", # Output only. ID of client customer which the user list is being licensed to. + "clientAccountType": "A String", # Output only. Product type of client customer which the user list is being licensed to. + "historicalPricings": [ # Output only. Pricing history of this user list license. + { # A user list license pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + ], + "licenseType": "A String", # Output only. Product type of client customer which the user list is being licensed to. + "metrics": { # Metrics related to a user list license. # Output only. Metrics related to this license This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call. + "clickCount": "A String", # Output only. The number of clicks for the user list license. + "endDate": "A String", # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `start_date` is used in the filter, `end_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + "impressionCount": "A String", # Output only. The number of impressions for the user list license. + "revenueUsdMicros": "A String", # Output only. The revenue for the user list license in USD micros. + "startDate": "A String", # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If `end_date` is used in the filter, `start_date` is also required. If neither `start_date` nor `end_date` are included in the filter, the UserListLicenseMetrics fields will not be populated in the response. + }, + "name": "A String", # Identifier. The resource name of the user list global license customer. + "pricing": { # A user list license pricing. # Output only. UserListDirectLicense pricing. + "buyerApprovalState": "A String", # Output only. The buyer approval state of this pricing. This field is read-only. + "costMicros": "A String", # Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. + "costType": "A String", # Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license. + "currencyCode": "A String", # Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217. + "endTime": "A String", # Optional. End time of the pricing. + "maxCostMicros": "A String", # Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if `currency_code` is `USD`. This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is no cap. + "pricingActive": True or False, # Output only. Whether this pricing is active. + "pricingId": "A String", # Output only. The ID of this pricing. + "startTime": "A String", # Output only. Start time of the pricing. + }, + "status": "A String", # Output only. Status of UserListDirectLicense - ENABLED or DISABLED. + "userListDisplayName": "A String", # Output only. Name of the user list being licensed. + "userListId": "A String", # Output only. ID of the user list being licensed. + }, + ], +}+++ + \ No newline at end of file diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html new file mode 100644 index 0000000000..6cf0a8f4d6 --- /dev/null +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html @@ -0,0 +1,538 @@ + + + +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++Data Manager API . accountTypes . accounts . userLists
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, validateOnly=None, x__xgafv=None)Creates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
++
+delete(name, validateOnly=None, x__xgafv=None)Deletes a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
+ +Gets a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
++
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists UserLists. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
+ +Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)Updates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}`
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, validateOnly=None, x__xgafv=None)+Creates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}` + +Args: + parent: string, Required. The parent account where this user list will be created. Format: accountTypes/{account_type}/accounts/{account} (required) + body: object, The request body. + The object takes the form of: + +{ # A user list resource. + "accessReason": "A String", # Output only. The reason this account has been granted access to the list. + "accountAccessStatus": "A String", # Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`. + "closingReason": "A String", # Output only. The reason why this user list membership status is closed. + "description": "A String", # Optional. A description of the user list. + "displayName": "A String", # Required. The display name of the user list. + "id": "A String", # Output only. The unique ID of the user list. + "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data. + "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data + "matchRatePercentage": 42, # Output only. Match rate for customer match user lists. + }, + "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`. + "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + "keySpace": "A String", # Required. Immutable. The key space of mobile IDs. + }, + "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. + "advertiserIdentifierCount": "A String", # Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. + "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. + "matchRatePercentage": 42, # Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. + "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. + "publisherName": "A String", # Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. + }, + "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners. + "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`. + "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience. + }, + "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`. + "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched). + "syncStatus": "A String", # Output only. Sync status of the user list. + }, + "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list. + "A String", + ], + "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + }, + }, + "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems. + "membershipDuration": "A String", # Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error. + "membershipStatus": "A String", # Optional. Membership status of this user list. + "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} + "readOnly": True or False, # Output only. An option that indicates if a user may edit a list. + "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks. + "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network. + "searchNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns. + }, + "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks. + "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network. + "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network. + }, +} + + validateOnly: boolean, Optional. If true, the request is validated but not executed. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A user list resource. + "accessReason": "A String", # Output only. The reason this account has been granted access to the list. + "accountAccessStatus": "A String", # Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`. + "closingReason": "A String", # Output only. The reason why this user list membership status is closed. + "description": "A String", # Optional. A description of the user list. + "displayName": "A String", # Required. The display name of the user list. + "id": "A String", # Output only. The unique ID of the user list. + "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data. + "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data + "matchRatePercentage": 42, # Output only. Match rate for customer match user lists. + }, + "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`. + "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + "keySpace": "A String", # Required. Immutable. The key space of mobile IDs. + }, + "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. + "advertiserIdentifierCount": "A String", # Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. + "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. + "matchRatePercentage": 42, # Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. + "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. + "publisherName": "A String", # Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. + }, + "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners. + "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`. + "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience. + }, + "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`. + "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched). + "syncStatus": "A String", # Output only. Sync status of the user list. + }, + "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list. + "A String", + ], + "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + }, + }, + "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems. + "membershipDuration": "A String", # Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error. + "membershipStatus": "A String", # Optional. Membership status of this user list. + "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} + "readOnly": True or False, # Output only. An option that indicates if a user may edit a list. + "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks. + "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network. + "searchNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns. + }, + "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks. + "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network. + "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network. + }, +}+++ +delete(name, validateOnly=None, x__xgafv=None)+Deletes a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}` + +Args: + name: string, Required. The name of the user list to delete. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} (required) + validateOnly: boolean, Optional. If true, the request is validated but not executed. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } +}+++ +get(name, x__xgafv=None)+Gets a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}` + +Args: + name: string, Required. The resource name of the UserList to retrieve. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A user list resource. + "accessReason": "A String", # Output only. The reason this account has been granted access to the list. + "accountAccessStatus": "A String", # Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`. + "closingReason": "A String", # Output only. The reason why this user list membership status is closed. + "description": "A String", # Optional. A description of the user list. + "displayName": "A String", # Required. The display name of the user list. + "id": "A String", # Output only. The unique ID of the user list. + "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data. + "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data + "matchRatePercentage": 42, # Output only. Match rate for customer match user lists. + }, + "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`. + "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + "keySpace": "A String", # Required. Immutable. The key space of mobile IDs. + }, + "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. + "advertiserIdentifierCount": "A String", # Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. + "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. + "matchRatePercentage": 42, # Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. + "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. + "publisherName": "A String", # Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. + }, + "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners. + "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`. + "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience. + }, + "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`. + "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched). + "syncStatus": "A String", # Output only. Sync status of the user list. + }, + "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list. + "A String", + ], + "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + }, + }, + "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems. + "membershipDuration": "A String", # Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error. + "membershipStatus": "A String", # Optional. Membership status of this user list. + "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} + "readOnly": True or False, # Output only. An option that indicates if a user may edit a list. + "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks. + "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network. + "searchNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns. + }, + "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks. + "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network. + "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network. + }, +}+++ +list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+Lists UserLists. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}` + +Args: + parent: string, Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account} (required) + filter: string, Optional. A [filter string](//google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = "list 1"`). Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types` + pageSize: integer, Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + pageToken: string, Optional. A page token, received from a previous `ListUserLists` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLists` must match the call that provided the page token. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message for ListUserLists. + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "userLists": [ # The user lists from the specified account. + { # A user list resource. + "accessReason": "A String", # Output only. The reason this account has been granted access to the list. + "accountAccessStatus": "A String", # Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`. + "closingReason": "A String", # Output only. The reason why this user list membership status is closed. + "description": "A String", # Optional. A description of the user list. + "displayName": "A String", # Required. The display name of the user list. + "id": "A String", # Output only. The unique ID of the user list. + "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data. + "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data + "matchRatePercentage": 42, # Output only. Match rate for customer match user lists. + }, + "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`. + "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + "keySpace": "A String", # Required. Immutable. The key space of mobile IDs. + }, + "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. + "advertiserIdentifierCount": "A String", # Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. + "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. + "matchRatePercentage": 42, # Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. + "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. + "publisherName": "A String", # Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. + }, + "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners. + "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`. + "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience. + }, + "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`. + "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched). + "syncStatus": "A String", # Output only. Sync status of the user list. + }, + "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list. + "A String", + ], + "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + }, + }, + "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems. + "membershipDuration": "A String", # Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error. + "membershipStatus": "A String", # Optional. Membership status of this user list. + "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} + "readOnly": True or False, # Output only. An option that indicates if a user may edit a list. + "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks. + "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network. + "searchNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns. + }, + "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks. + "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network. + "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network. + }, + }, + ], +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ + \ No newline at end of file diff --git a/docs/dyn/datamanager_v1.accountTypes.html b/docs/dyn/datamanager_v1.accountTypes.html new file mode 100644 index 0000000000..83957180a0 --- /dev/null +++ b/docs/dyn/datamanager_v1.accountTypes.html @@ -0,0 +1,91 @@ + + + +patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)+Updates a UserList. Authorization Headers: This method supports the following optional headers to define how the API authorizes access for the request: * `login-account`: (Optional) The resource name of the account where the Google Account of the credentials is a user. If not set, defaults to the account of the request. Format: `accountTypes/{loginAccountType}/accounts/{loginAccountId}` * `linked-account`: (Optional) The resource name of the account with an established product link to the `login-account`. Format: `accountTypes/{linkedAccountType}/accounts/{linkedAccountId}` + +Args: + name: string, Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} (required) + body: object, The request body. + The object takes the form of: + +{ # A user list resource. + "accessReason": "A String", # Output only. The reason this account has been granted access to the list. + "accountAccessStatus": "A String", # Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`. + "closingReason": "A String", # Output only. The reason why this user list membership status is closed. + "description": "A String", # Optional. A description of the user list. + "displayName": "A String", # Required. The display name of the user list. + "id": "A String", # Output only. The unique ID of the user list. + "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data. + "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data + "matchRatePercentage": 42, # Output only. Match rate for customer match user lists. + }, + "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`. + "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + "keySpace": "A String", # Required. Immutable. The key space of mobile IDs. + }, + "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. + "advertiserIdentifierCount": "A String", # Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. + "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. + "matchRatePercentage": 42, # Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. + "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. + "publisherName": "A String", # Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. + }, + "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners. + "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`. + "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience. + }, + "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`. + "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched). + "syncStatus": "A String", # Output only. Sync status of the user list. + }, + "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list. + "A String", + ], + "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + }, + }, + "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems. + "membershipDuration": "A String", # Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error. + "membershipStatus": "A String", # Optional. Membership status of this user list. + "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} + "readOnly": True or False, # Output only. An option that indicates if a user may edit a list. + "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks. + "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network. + "searchNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns. + }, + "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks. + "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network. + "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network. + }, +} + + updateMask: string, Optional. The list of fields to update. + validateOnly: boolean, Optional. If true, the request is validated but not executed. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A user list resource. + "accessReason": "A String", # Output only. The reason this account has been granted access to the list. + "accountAccessStatus": "A String", # Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to `ENABLED`. Later the user list owner can decide to revoke the share and make it `DISABLED`. + "closingReason": "A String", # Output only. The reason why this user list membership status is closed. + "description": "A String", # Optional. A description of the user list. + "displayName": "A String", # Required. The display name of the user list. + "id": "A String", # Output only. The unique ID of the user list. + "ingestedUserListInfo": { # Represents a user list that is populated by user provided data. # Optional. Represents a user list that is populated by user ingested data. + "contactIdInfo": { # Additional information when `CONTACT_ID` is one of the `upload_key_types`. # Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data + "matchRatePercentage": 42, # Output only. Match rate for customer match user lists. + }, + "mobileIdInfo": { # Additional information when `MOBILE_ID` is one of the `upload_key_types`. # Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`. + "appId": "A String", # Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + "keySpace": "A String", # Required. Immutable. The key space of mobile IDs. + }, + "pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. + "advertiserIdentifierCount": "A String", # Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list. + "cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers. + "matchRatePercentage": 42, # Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive. + "publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms. + "publisherName": "A String", # Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience. + }, + "partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners. + "commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`. + "partnerAudienceSource": "A String", # Required. Immutable. The source of the partner audience. + }, + "pseudonymousIdInfo": { # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`. # Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`. + "billableRecordCount": "A String", # Optional. Immutable. The number of billable records (e.g. uploaded or matched). + "syncStatus": "A String", # Output only. Sync status of the user list. + }, + "uploadKeyTypes": [ # Required. Immutable. Upload key types of this user list. + "A String", + ], + "userIdInfo": { # Additional information when `USER_ID` is one of the `upload_key_types`. # Optional. Additional information when `USER_ID` is one of the `upload_key_types`. + "dataSourceType": "A String", # Optional. Immutable. Source of the upload data. + }, + }, + "integrationCode": "A String", # Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems. + "membershipDuration": "A String", # Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error. + "membershipStatus": "A String", # Optional. Membership status of this user list. + "name": "A String", # Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list} + "readOnly": True or False, # Output only. An option that indicates if a user may edit a list. + "sizeInfo": { # Estimated number of members in this user list in different target networks. # Output only. Estimated number of members in this user list in different target networks. + "displayNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list, on the Google Display Network. + "searchNetworkMembersCount": "A String", # Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns. + }, + "targetNetworkInfo": { # Eligibility information for different target networks. # Optional. Eligibility information for different target networks. + "eligibleForDisplay": True or False, # Output only. Indicates this user list is eligible for Google Display Network. + "eligibleForSearch": True or False, # Optional. Indicates if this user list is eligible for Google Search Network. + }, +}+Data Manager API . accountTypes
+Instance Methods
++
+accounts()+Returns the accounts Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/datamanager_v1.audienceMembers.html b/docs/dyn/datamanager_v1.audienceMembers.html index 342d814fa9..bf38e52c4c 100644 --- a/docs/dyn/datamanager_v1.audienceMembers.html +++ b/docs/dyn/datamanager_v1.audienceMembers.html @@ -112,11 +112,16 @@close()+Close httplib2 connections.+Method Details
"A String", ], }, - "pairData": { # [PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience. At least one PAIR ID is required. # [Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908). + "pairData": { # [PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience. At least one PAIR ID is required. This feature is only available to data partners. # [Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908). This feature is only available to data partners. "pairIds": [ # Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the [PAIR]((//support.google.com/admanager/answer/15067908)) user list. At most 10 `pairIds` can be provided in a single AudienceMember. "A String", ], }, + "ppidData": { # Publisher provided identifiers data holding the ppids. At least one ppid is required. This feature is only available to data partners. # Data related to publisher provided identifiers. This feature is only available to data partners. + "ppids": [ # Required. The list of publisher provided identifiers for a user. + "A String", + ], + }, "userData": { # Data that identifies the user. At least one identifier is required. # User-provided data that identifies the user. "userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event. { # A single identifier for the user. @@ -131,6 +136,9 @@Method Details
}, ], }, + "userIdData": { # User id data holding the user id. # Data related to unique identifiers for a user, as defined by the advertiser. + "userId": "A String", # Required. A unique identifier for a user, as defined by the advertiser. + }, }, ], "consent": { # [Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user. # Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each AudienceMember. @@ -215,11 +223,16 @@Method Details
"A String", ], }, - "pairData": { # [PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience. At least one PAIR ID is required. # [Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908). + "pairData": { # [PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience. At least one PAIR ID is required. This feature is only available to data partners. # [Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908). This feature is only available to data partners. "pairIds": [ # Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the [PAIR]((//support.google.com/admanager/answer/15067908)) user list. At most 10 `pairIds` can be provided in a single AudienceMember. "A String", ], }, + "ppidData": { # Publisher provided identifiers data holding the ppids. At least one ppid is required. This feature is only available to data partners. # Data related to publisher provided identifiers. This feature is only available to data partners. + "ppids": [ # Required. The list of publisher provided identifiers for a user. + "A String", + ], + }, "userData": { # Data that identifies the user. At least one identifier is required. # User-provided data that identifies the user. "userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event. { # A single identifier for the user. @@ -234,6 +247,9 @@Method Details
}, ], }, + "userIdData": { # User id data holding the user id. # Data related to unique identifiers for a user, as defined by the advertiser. + "userId": "A String", # Required. A unique identifier for a user, as defined by the advertiser. + }, }, ], "destinations": [ # Required. The list of destinations to remove the users from. diff --git a/docs/dyn/datamanager_v1.html b/docs/dyn/datamanager_v1.html index f757499f8e..591cc2fa1a 100644 --- a/docs/dyn/datamanager_v1.html +++ b/docs/dyn/datamanager_v1.html @@ -74,6 +74,11 @@Data Manager API
Instance Methods
++
+accountTypes()+Returns the accountTypes Resource.
+ diff --git a/docs/dyn/datamanager_v1.requestStatus.html b/docs/dyn/datamanager_v1.requestStatus.html index cc2111b0d0..3c9fd359d9 100644 --- a/docs/dyn/datamanager_v1.requestStatus.html +++ b/docs/dyn/datamanager_v1.requestStatus.html @@ -112,11 +112,19 @@Method Details
"pairIdCount": "A String", # The total count of pair ids sent in the upload request for the destination. Includes all pair ids in the request, regardless of whether they were successfully ingested or not. "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. }, + "ppidDataIngestionStatus": { # The status of the ppid data ingestion to the destination containing stats related to the ingestion. # The status of the ppid data ingestion to the destination. + "ppidCount": "A String", # The total count of ppids sent in the upload request for the destination. Includes all ppids in the request, regardless of whether they were successfully ingested or not. + "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. + }, "userDataIngestionStatus": { # The status of the user data ingestion to the destination containing stats related to the ingestion. # The status of the user data ingestion to the destination. "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. "uploadMatchRateRange": "A String", # The match rate range of the upload. "userIdentifierCount": "A String", # The total count of user identifiers sent in the upload request for the destination. Includes all user identifiers in the request, regardless of whether they were successfully ingested or not. }, + "userIdDataIngestionStatus": { # The status of the user id data ingestion to the destination containing stats related to the ingestion. # The status of the user id data ingestion to the destination. + "recordCount": "A String", # The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not. + "userIdCount": "A String", # The total count of user ids sent in the upload request for the destination. Includes all user ids in the request, regardless of whether they were successfully ingested or not. + }, }, "audienceMembersRemovalStatus": { # The status of the remove audience members request. # The status of the remove audience members request. "mobileDataRemovalStatus": { # The status of the mobile data removal from the destination. # The status of the mobile data removal from the destination. @@ -127,10 +135,18 @@Method Details
"pairIdCount": "A String", # The total count of pair ids sent in the removal request. Includes all pair ids in the request, regardless of whether they were successfully removed or not. "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. }, + "ppidDataRemovalStatus": { # The status of the ppid data removal from the destination. # The status of the ppid data removal from the destination. + "ppidCount": "A String", # The total count of ppids sent in the removal request. Includes all ppids in the request, regardless of whether they were successfully removed or not. + "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. + }, "userDataRemovalStatus": { # The status of the user data removal from the destination. # The status of the user data removal from the destination. "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. "userIdentifierCount": "A String", # The total count of user identifiers sent in the removal request. Includes all user identifiers in the request, regardless of whether they were successfully removed or not. }, + "userIdDataRemovalStatus": { # The status of the user id data removal from the destination. # The status of the user id data removal from the destination. + "recordCount": "A String", # The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not. + "userIdCount": "A String", # The total count of user ids sent in the removal request. Includes all user ids in the request, regardless of whether they were successfully removed or not. + }, }, "destination": { # The Google product you're sending data to. For example, a Google Ads account. # A destination within a DM API request. "linkedAccount": { # Represents a specific account. # Optional. An account that the calling user's `login_account` has access to, through an established account link. For example, a data partner's `login_account` might have access to a client's `linked_account`. The partner might use this field to send data from the `linked_account` to another `operating_account`. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index 1c65b1b25f..1a0c368a0c 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -337,6 +337,17 @@Method Details
"rules": [ # Output only. A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. + "debugQueriesResultSets": [ # Output only. Contains the results of all debug queries for this rule. The number of result sets will correspond to the number of debug_queries. + { # Contains all results from a debug query. + "results": [ # Output only. Contains all results. Up to 10 results can be returned. + { # Contains a single result from the debug query. + "name": "A String", # Specifies the name of the result. Available if provided with an explicit alias using [AS] alias. + "type": "A String", # Indicates the data type of the result. For more information, see BigQuery data types (https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types). + "value": "A String", # Represents the value of the result as a string. + }, + ], + }, + ], "evaluatedCount": "A String", # Output only. The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # Output only. The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # Output only. The number of rows with null values in the specified column. @@ -345,6 +356,12 @@Method Details
"passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -422,6 +439,12 @@Method Details
"rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -587,6 +610,12 @@Method Details
"rule": [ # The data quality rules that Dataplex Universal Catalog generates based on the results of a data profiling scan. { # A rule captures data quality intent about a data source. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -858,6 +887,17 @@Method Details
"rules": [ # Output only. A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. + "debugQueriesResultSets": [ # Output only. Contains the results of all debug queries for this rule. The number of result sets will correspond to the number of debug_queries. + { # Contains all results from a debug query. + "results": [ # Output only. Contains all results. Up to 10 results can be returned. + { # Contains a single result from the debug query. + "name": "A String", # Specifies the name of the result. Available if provided with an explicit alias using [AS] alias. + "type": "A String", # Indicates the data type of the result. For more information, see BigQuery data types (https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types). + "value": "A String", # Represents the value of the result as a string. + }, + ], + }, + ], "evaluatedCount": "A String", # Output only. The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # Output only. The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # Output only. The number of rows with null values in the specified column. @@ -866,6 +906,12 @@Method Details
"passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -943,6 +989,12 @@Method Details
"rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -1293,6 +1345,17 @@Method Details
"rules": [ # Output only. A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. + "debugQueriesResultSets": [ # Output only. Contains the results of all debug queries for this rule. The number of result sets will correspond to the number of debug_queries. + { # Contains all results from a debug query. + "results": [ # Output only. Contains all results. Up to 10 results can be returned. + { # Contains a single result from the debug query. + "name": "A String", # Specifies the name of the result. Available if provided with an explicit alias using [AS] alias. + "type": "A String", # Indicates the data type of the result. For more information, see BigQuery data types (https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types). + "value": "A String", # Represents the value of the result as a string. + }, + ], + }, + ], "evaluatedCount": "A String", # Output only. The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # Output only. The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # Output only. The number of rows with null values in the specified column. @@ -1301,6 +1364,12 @@Method Details
"passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -1378,6 +1447,12 @@Method Details
"rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -1689,6 +1764,17 @@Method Details
"rules": [ # Output only. A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. + "debugQueriesResultSets": [ # Output only. Contains the results of all debug queries for this rule. The number of result sets will correspond to the number of debug_queries. + { # Contains all results from a debug query. + "results": [ # Output only. Contains all results. Up to 10 results can be returned. + { # Contains a single result from the debug query. + "name": "A String", # Specifies the name of the result. Available if provided with an explicit alias using [AS] alias. + "type": "A String", # Indicates the data type of the result. For more information, see BigQuery data types (https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types). + "value": "A String", # Represents the value of the result as a string. + }, + ], + }, + ], "evaluatedCount": "A String", # Output only. The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # Output only. The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # Output only. The number of rows with null values in the specified column. @@ -1697,6 +1783,12 @@Method Details
"passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -1774,6 +1866,12 @@Method Details
"rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -2103,6 +2201,17 @@Method Details
"rules": [ # Output only. A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. + "debugQueriesResultSets": [ # Output only. Contains the results of all debug queries for this rule. The number of result sets will correspond to the number of debug_queries. + { # Contains all results from a debug query. + "results": [ # Output only. Contains all results. Up to 10 results can be returned. + { # Contains a single result from the debug query. + "name": "A String", # Specifies the name of the result. Available if provided with an explicit alias using [AS] alias. + "type": "A String", # Indicates the data type of the result. For more information, see BigQuery data types (https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types). + "value": "A String", # Represents the value of the result as a string. + }, + ], + }, + ], "evaluatedCount": "A String", # Output only. The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # Output only. The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # Output only. The number of rows with null values in the specified column. @@ -2111,6 +2220,12 @@Method Details
"passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -2188,6 +2303,12 @@Method Details
"rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html index 1838f758d0..d8a0908535 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html @@ -119,6 +119,12 @@Method Details
"rule": [ # The data quality rules that Dataplex Universal Catalog generates based on the results of a data profiling scan. { # A rule captures data quality intent about a data source. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -386,6 +392,17 @@Method Details
"rules": [ # Output only. A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. + "debugQueriesResultSets": [ # Output only. Contains the results of all debug queries for this rule. The number of result sets will correspond to the number of debug_queries. + { # Contains all results from a debug query. + "results": [ # Output only. Contains all results. Up to 10 results can be returned. + { # Contains a single result from the debug query. + "name": "A String", # Specifies the name of the result. Available if provided with an explicit alias using [AS] alias. + "type": "A String", # Indicates the data type of the result. For more information, see BigQuery data types (https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types). + "value": "A String", # Represents the value of the result as a string. + }, + ], + }, + ], "evaluatedCount": "A String", # Output only. The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # Output only. The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # Output only. The number of rows with null values in the specified column. @@ -394,6 +411,12 @@Method Details
"passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -471,6 +494,12 @@Method Details
"rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -747,6 +776,17 @@Method Details
"rules": [ # Output only. A list of all the rules in a job, and their results. { # DataQualityRuleResult provides a more detailed, per-rule view of the results. "assertionRowCount": "A String", # Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. + "debugQueriesResultSets": [ # Output only. Contains the results of all debug queries for this rule. The number of result sets will correspond to the number of debug_queries. + { # Contains all results from a debug query. + "results": [ # Output only. Contains all results. Up to 10 results can be returned. + { # Contains a single result from the debug query. + "name": "A String", # Specifies the name of the result. Available if provided with an explicit alias using [AS] alias. + "type": "A String", # Indicates the data type of the result. For more information, see BigQuery data types (https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types). + "value": "A String", # Represents the value of the result as a string. + }, + ], + }, + ], "evaluatedCount": "A String", # Output only. The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.This field is not set for rule SqlAssertion. "failingRowsQuery": "A String", # Output only. The query to find rows that did not pass this rule.This field is only valid for row-level type rules. "nullCount": "A String", # Output only. The number of rows with null values in the specified column. @@ -755,6 +795,12 @@Method Details
"passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation @@ -832,6 +878,12 @@Method Details
"rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. "column": "A String", # Optional. The unnested column which this rule is evaluated against. + "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. + { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} + "description": "A String", # Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. + "sqlStatement": "A String", # Required. Specifies the SQL statement to be executed. + }, + ], "description": "A String", # Optional. Description of the rule. The maximum length is 1,024 characters. "dimension": "A String", # Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. "ignoreNull": True or False, # Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid for the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index 12230093ce..92448e990d 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -169,6 +169,12 @@Instance Methods
lookupEntry(name, aspectTypes=None, entry=None, paths=None, view=None, x__xgafv=None)Looks up an entry by name using the permission on the source system.
+ +Looks up Entry Links referencing the specified Entry.
+ +Retrieves the next page of results.
Searches for Entries matching the given query and scope.
@@ -327,6 +333,63 @@Method Details
}++ +lookupEntryLinks(name, entry=None, entryLinkTypes=None, entryMode=None, pageSize=None, pageToken=None, x__xgafv=None)+Looks up Entry Links referencing the specified Entry. + +Args: + name: string, Required. The project to which the request should be attributed to Format: projects/{project_id_or_number}/locations/{location_id}. (required) + entry: string, Required. The resource name of the referred Entry. Format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. Entry Links which references this entry will be returned in the response. + entryLinkTypes: string, Entry link types to filter the response by. If empty, all entry link types will be returned. At most 10 entry link types can be specified. (repeated) + entryMode: string, Mode of entry reference. + Allowed values + ENTRY_MODE_UNSPECIFIED - Unspecified entry mode. Returns both directional and non-directional entry links which references the entry. + SOURCE - Returns all directed entry links which references the entry as source. + TARGET - Return all directed entry links which references the entry as target. + pageSize: integer, Maximum number of EntryLinks to return. The service may return fewer than this value. If unspecified, at most 10 EntryLinks will be returned. The maximum value is 10; values above 10 will be coerced to 10. + pageToken: string, Page token received from a previous LookupEntryLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters that are provided to the LookupEntryLinks request must match the call that provided the page token. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message for LookupEntryLinks. + "entryLinks": [ # List of entry links that reference the specified entry. + { # EntryLink represents a link between two Entries. + "createTime": "A String", # Output only. The time when the Entry Link was created. + "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition + "entryReferences": [ # Required. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references. + { # Reference to the Entry that is linked through the Entry Link. + "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link. + "type": "A String", # Required. Immutable. The reference type of the Entry. + }, + ], + "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "updateTime": "A String", # Output only. The time when the Entry Link was last updated. + }, + ], + "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. +}+++lookupEntryLinks_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++@@ -882,6 +884,7 @@searchEntries(name, orderBy=None, pageSize=None, pageToken=None, query=None, scope=None, semanticSearch=None, x__xgafv=None)Searches for Entries matching the given query and scope. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html index 36fefd4cd3..36366d41ae 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html @@ -385,6 +385,7 @@Method Details
"volumeGainDb": 3.14, }, "updateTime": "A String", + "useBidiStreaming": True or False, } x__xgafv: string, V1 error format. @@ -621,6 +622,7 @@Method Details
"volumeGainDb": 3.14, }, "updateTime": "A String", + "useBidiStreaming": True or False, }Method Details
"volumeGainDb": 3.14, }, "updateTime": "A String", + "useBidiStreaming": True or False, }Method Details
"volumeGainDb": 3.14, }, "updateTime": "A String", + "useBidiStreaming": True or False, }, ], "nextPageToken": "A String", @@ -1384,6 +1388,7 @@Method Details
"volumeGainDb": 3.14, }, "updateTime": "A String", + "useBidiStreaming": True or False, } updateMask: string, A parameter @@ -1621,6 +1626,7 @@Method Details
"volumeGainDb": 3.14, }, "updateTime": "A String", + "useBidiStreaming": True or False, }
+ message()
+
Returns the message Resource.
+Returns the operations Resource.
+
+ tasks()
+
Returns the tasks Resource.
+Close httplib2 connections.
+
+ getCard(tenant, x__xgafv=None)
GetAgentCard returns the agent card for the agent.
close()
Close httplib2 connections.
getCard(tenant, x__xgafv=None)
+ GetAgentCard returns the agent card for the agent.
+
+Args:
+ tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # AgentCard conveys key information: - Overall details (version, name, description, uses) - Skills; a set of actions/solutions the agent can perform - Default modalities/content types supported by the agent. - Authentication requirements Next ID: 19
+ "additionalInterfaces": [ # Announcement of additional supported transports. Client can use any of the supported transports.
+ { # Defines additional transport information for the agent.
+ "tenant": "A String", # Tenant to be set in the request when calling the agent. Experimental, might still change for 1.0 release.
+ "transport": "A String", # The transport supported this url. This is an open form string, to be easily extended for many transport protocols. The core ones officially supported are JSONRPC, GRPC and HTTP+JSON.
+ "url": "A String", # The url this interface is found at.
+ },
+ ],
+ "capabilities": { # Defines the A2A feature set supported by the agent # A2A Capability set supported by the agent.
+ "extensions": [ # Extensions supported by this agent.
+ { # A declaration of an extension supported by an Agent.
+ "description": "A String", # A description of how this agent uses this extension. Example: "Google OAuth 2.0 authentication"
+ "params": { # Optional configuration for the extension.
+ "a_key": "", # Properties of the object.
+ },
+ "required": True or False, # Whether the client must follow specific requirements of the extension. Example: false
+ "uri": "A String", # The URI of the extension. Example: "https://developers.google.com/identity/protocols/oauth2"
+ },
+ ],
+ "pushNotifications": True or False, # If the agent can send push notifications to the clients webhook
+ "streaming": True or False, # If the agent will support streaming responses
+ },
+ "defaultInputModes": [ # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as mime types.
+ "A String",
+ ],
+ "defaultOutputModes": [ # The mime types supported as outputs from this agent.
+ "A String",
+ ],
+ "description": "A String", # A description of the agent's domain of action/solution space. Example: "Agent that helps users with recipes and cooking."
+ "documentationUrl": "A String", # A url to provide additional documentation about the agent.
+ "iconUrl": "A String", # An optional URL to an icon for the agent.
+ "name": "A String", # A human readable name for the agent. Example: "Recipe Agent"
+ "preferredTransport": "A String", # The transport of the preferred endpoint. If empty, defaults to JSONRPC.
+ "protocolVersion": "A String", # The version of the A2A protocol this agent supports.
+ "provider": { # Represents information about the service provider of an agent. # The service provider of the agent.
+ "organization": "A String", # The providers organization name Example: "Google"
+ "url": "A String", # The providers reference url Example: "https://ai.google.dev"
+ },
+ "security": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security requirements for contacting the agent. This list can be seen as an OR of ANDs. Each object in the list describes one possible set of security requirements that must be present on a request. This allows specifying, for example, "callers must either use OAuth OR an API Key AND mTLS." Example: security { schemes { key: "oauth" value { list: ["read"] } } } security { schemes { key: "api-key" } schemes { key: "mtls" } }
+ {
+ "schemes": {
+ "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED
+ "list": [
+ "A String",
+ ],
+ },
+ },
+ },
+ ],
+ "securitySchemes": { # The security scheme details used for authenticating with this agent.
+ "a_key": {
+ "apiKeySecurityScheme": {
+ "description": "A String", # Description of this security scheme.
+ "location": "A String", # Location of the API key, valid values are "query", "header", or "cookie"
+ "name": "A String", # Name of the header, query or cookie parameter to be used.
+ },
+ "httpAuthSecurityScheme": {
+ "bearerFormat": "A String", # A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.
+ "description": "A String", # Description of this security scheme.
+ "scheme": "A String", # The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry. The value is case-insensitive, as defined in RFC7235.
+ },
+ "mtlsSecurityScheme": {
+ "description": "A String", # Description of this security scheme.
+ },
+ "oauth2SecurityScheme": {
+ "description": "A String", # Description of this security scheme.
+ "flows": { # An object containing configuration information for the flow types supported
+ "authorizationCode": {
+ "authorizationUrl": "A String", # The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS
+ "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ "scopes": { # The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
+ "a_key": "A String",
+ },
+ "tokenUrl": "A String", # The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ },
+ "clientCredentials": {
+ "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ "scopes": { # The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
+ "a_key": "A String",
+ },
+ "tokenUrl": "A String", # The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ },
+ "implicit": {
+ "authorizationUrl": "A String", # The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS
+ "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ "scopes": { # The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
+ "a_key": "A String",
+ },
+ },
+ "password": {
+ "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ "scopes": { # The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
+ "a_key": "A String",
+ },
+ "tokenUrl": "A String", # The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
+ },
+ },
+ "oauth2MetadataUrl": "A String", # URL to the oauth2 authorization server metadata [RFC8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.
+ },
+ "openIdConnectSecurityScheme": {
+ "description": "A String", # Description of this security scheme.
+ "openIdConnectUrl": "A String", # Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata.
+ },
+ },
+ },
+ "signatures": [ # JSON Web Signatures computed for this AgentCard.
+ { # AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).
+ "header": { # The unprotected JWS header values.
+ "a_key": "", # Properties of the object.
+ },
+ "protected": "A String", # Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object. Required.
+ "signature": "A String", # Required. The computed signature, base64url-encoded. Required.
+ },
+ ],
+ "skills": [ # Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
+ { # AgentSkill represents a unit of action/solution that the agent can perform. One can think of this as a type of highly reliable solution that an agent can be tasked to provide. Agents have the autonomy to choose how and when to use specific skills, but clients should have confidence that if the skill is defined that unit of action can be reliably performed.
+ "description": "A String", # A human (or llm) readable description of the skill details and behaviors.
+ "examples": [ # A set of example queries that this skill is designed to address. These examples should help the caller to understand how to craft requests to the agent to achieve specific goals. Example: ["I need a recipe for bread"]
+ "A String",
+ ],
+ "id": "A String", # Unique identifier of the skill within this agent.
+ "inputModes": [ # Possible input modalities supported.
+ "A String",
+ ],
+ "name": "A String", # A human readable name for the skill.
+ "outputModes": [ # Possible output modalities produced
+ "A String",
+ ],
+ "security": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security schemes necessary for the agent to leverage this skill. As in the overall AgentCard.security, this list represents a logical OR of security requirement objects. Each object is a set of security schemes that must be used together (a logical AND). protolint:enable REPEATED_FIELD_NAMES_PLURALIZED
+ {
+ "schemes": {
+ "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED
+ "list": [
+ "A String",
+ ],
+ },
+ },
+ },
+ ],
+ "tags": [ # A set of tags for the skill to enhance categorization/utilization. Example: ["cooking", "customer support", "billing"]
+ "A String",
+ ],
+ },
+ ],
+ "supportsAuthenticatedExtendedCard": True or False, # Whether the agent supports providing an extended agent card when the user is authenticated, i.e. is the card from .well-known different than the card from GetAgentCard.
+ "url": "A String", # A URL to the address the agent is hosted at. This represents the preferred endpoint as declared by the agent.
+ "version": "A String", # The version of the agent. Example: "1.0.0"
+}
+