From cced60843bdb9c979c6749ef0751e1e11543afe6 Mon Sep 17 00:00:00 2001
From: Yoshi Automation Instance Methods
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 00000000000..9a5f20eaf0f --- /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/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json
index 5b6b3e64480..db52eec2598 100644
--- a/googleapiclient/discovery_cache/documents/apigee.v1.json
+++ b/googleapiclient/discovery_cache/documents/apigee.v1.json
@@ -10384,6 +10384,21 @@
"pattern": "^organizations/[^/]+/securityMonitoringConditions/[^/]+$",
"required": true,
"type": "string"
+},
+"riskAssessmentType": {
+"description": "Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.",
+"enum": [
+"RISK_ASSESSMENT_TYPE_UNSPECIFIED",
+"APIGEE",
+"API_HUB"
+],
+"enumDescriptions": [
+"Risk assessment type is not specified.",
+"Risk assessment type is Apigee.",
+"Risk assessment type is API Hub."
+],
+"location": "query",
+"type": "string"
}
},
"path": "v1/{+name}",
@@ -10409,6 +10424,21 @@
"pattern": "^organizations/[^/]+/securityMonitoringConditions/[^/]+$",
"required": true,
"type": "string"
+},
+"riskAssessmentType": {
+"description": "Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.",
+"enum": [
+"RISK_ASSESSMENT_TYPE_UNSPECIFIED",
+"APIGEE",
+"API_HUB"
+],
+"enumDescriptions": [
+"Risk assessment type is not specified.",
+"Risk assessment type is Apigee.",
+"Risk assessment type is API Hub."
+],
+"location": "query",
+"type": "string"
}
},
"path": "v1/{+name}",
@@ -10429,7 +10459,7 @@
],
"parameters": {
"filter": {
-"description": "Optional. Filter for the monitoring conditions. For example: `profile=profile1 AND scope=env1`",
+"description": "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`",
"location": "query",
"type": "string"
},
@@ -10450,6 +10480,21 @@
"pattern": "^organizations/[^/]+$",
"required": true,
"type": "string"
+},
+"riskAssessmentType": {
+"description": "Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.",
+"enum": [
+"RISK_ASSESSMENT_TYPE_UNSPECIFIED",
+"APIGEE",
+"API_HUB"
+],
+"enumDescriptions": [
+"Risk assessment type is not specified.",
+"Risk assessment type is Apigee.",
+"Risk assessment type is API Hub."
+],
+"location": "query",
+"type": "string"
}
},
"path": "v1/{+parent}/securityMonitoringConditions",
@@ -11914,7 +11959,7 @@
}
}
},
-"revision": "20260130",
+"revision": "20260218",
"rootUrl": "https://apigee.googleapis.com/",
"schemas": {
"ApiservingMcpMcpToolDataHandlingProfile": {
@@ -19716,6 +19761,24 @@
"description": "Output only. Additional details for the API Hub deployment.",
"readOnly": true
},
+"apiHubGatewayType": {
+"description": "Optional. ",
+"enum": [
+"API_HUB_GATEWAY_TYPE_UNSPECIFIED",
+"APIGEE_X",
+"APIGEE_HYBRID",
+"APIGEE_EDGE",
+"APIGEE_OPDK"
+],
+"enumDescriptions": [
+"Gateway type is not specified.",
+"Gateway is Apigee X for API Hub.",
+"Gateway is Apigee Hybrid for API Hub.",
+"Gateway is Apigee Edge for API Hub.",
+"Gateway is Apigee OPDK for API Hub."
+],
+"type": "string"
+},
"name": {
"description": "Required. Name of this resource. For an Apigee API Proxy, this should be the id of the API proxy. For an API Hub Deployment, this should be the id of the deployment.",
"type": "string"
@@ -20096,6 +20159,10 @@
"description": "Security monitoring condition for risk assessment version 2.",
"id": "GoogleCloudApigeeV1SecurityMonitoringCondition",
"properties": {
+"apiHubGateway": {
+"description": "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}`",
+"type": "string"
+},
"createTime": {
"description": "Output only. The time of the security monitoring condition creation.",
"format": "google-datetime",
@@ -20118,8 +20185,22 @@
"description": "Required. ID of security profile of the security monitoring condition.",
"type": "string"
},
+"riskAssessmentType": {
+"description": "Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.",
+"enum": [
+"RISK_ASSESSMENT_TYPE_UNSPECIFIED",
+"APIGEE",
+"API_HUB"
+],
+"enumDescriptions": [
+"Risk assessment type is not specified.",
+"Risk assessment type is Apigee.",
+"Risk assessment type is API Hub."
+],
+"type": "string"
+},
"scope": {
-"description": "Optional. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.",
+"description": "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.",
"type": "string"
},
"totalDeployedResources": {
From f878562ac70d5bdd95ddf499ce2d781308cf97f0 Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 24 Feb 2026 07:27:55 +0000
Subject: [PATCH 03/29] feat(appengine): update the api
#### appengine:v1beta
The following keys were deleted:
- schemas.SubnetworkKey (Total Keys: 4)
- schemas.Version.properties.vpcEgress (Total Keys: 2)
- schemas.VpcEgress (Total Keys: 7)
- schemas.VpcNetworkTag (Total Keys: 3)
---
...pengine_v1beta.apps.services.versions.html | 48 --------------
...ations.applications.services.versions.html | 12 ----
.../documents/appengine.v1beta.json | 66 +------------------
3 files changed, 1 insertion(+), 125 deletions(-)
diff --git a/docs/dyn/appengine_v1beta.apps.services.versions.html b/docs/dyn/appengine_v1beta.apps.services.versions.html
index e45c4b630ba..79036421cf3 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 987234bb74c..7b9f692fe1c 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/googleapiclient/discovery_cache/documents/appengine.v1beta.json b/googleapiclient/discovery_cache/documents/appengine.v1beta.json
index 3f52ef0b4ac..8ef9ead2ac4 100644
--- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json
@@ -2868,7 +2868,7 @@
}
}
},
-"revision": "20260202",
+"revision": "20260220",
"rootUrl": "https://appengine.googleapis.com/",
"schemas": {
"ApiConfigHandler": {
@@ -5120,21 +5120,6 @@ true
},
"type": "object"
},
-"SubnetworkKey": {
-"description": "Subnetwork key message.",
-"id": "SubnetworkKey",
-"properties": {
-"hostProjectId": {
-"description": "Project id (name not number) of the project that hosts the network",
-"type": "string"
-},
-"subnet": {
-"description": "Short name of the subnetwork. e.g. SUBNET instead of projects/{PROJECT_NAME}/regions/{REGION}/subnetworks/{SUBNET}",
-"type": "string"
-}
-},
-"type": "object"
-},
"TrafficSplit": {
"description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
"id": "TrafficSplit",
@@ -5554,11 +5539,6 @@ true
"$ref": "VpcAccessConnector",
"description": "Enables VPC connectivity for standard apps."
},
-"vpcEgress": {
-"$ref": "VpcEgress",
-"deprecated": true,
-"description": "Deprecated: Use vpc_access instead. Enables VPC egress connectivity for standard apps."
-},
"zones": {
"description": "The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.",
"items": {
@@ -5642,39 +5622,6 @@ true
},
"type": "object"
},
-"VpcEgress": {
-"deprecated": true,
-"description": "Deprecated: Use VpcAccess instead. Vpc Egress configuration.",
-"id": "VpcEgress",
-"properties": {
-"egressSetting": {
-"description": "The egress setting for the subnetwork, controlling what traffic is diverted through it.",
-"enum": [
-"EGRESS_SETTING_UNSPECIFIED",
-"ALL_TRAFFIC",
-"PRIVATE_IP_RANGES"
-],
-"enumDescriptions": [
-"No value set; apply default behavior",
-"Force all traffic to egress through the NetworkInterface (and configured VPC Network)",
-"Force all Private IP Space traffic to egress through NetworkInterface (and configured VPC Network)"
-],
-"type": "string"
-},
-"networkTags": {
-"description": "The network tags to apply to the instance.",
-"items": {
-"$ref": "VpcNetworkTag"
-},
-"type": "array"
-},
-"subnetworkKey": {
-"$ref": "SubnetworkKey",
-"description": "The subnetwork key."
-}
-},
-"type": "object"
-},
"VpcNetworkInterface": {
"description": "Network interface key message.",
"id": "VpcNetworkInterface",
@@ -5697,17 +5644,6 @@ true
},
"type": "object"
},
-"VpcNetworkTag": {
-"description": "Network tag message.",
-"id": "VpcNetworkTag",
-"properties": {
-"value": {
-"description": "value for the tag name",
-"type": "string"
-}
-},
-"type": "object"
-},
"ZipInfo": {
"description": "The zip file information for a zip deployment.",
"id": "ZipInfo",
From e565fc7b0b626540aa388c673af0701ad3949307 Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 24 Feb 2026 07:27:55 +0000
Subject: [PATCH 04/29] feat(cloudkms): update the api
#### cloudkms:v1
The following keys were added:
- schemas.Digest.properties.externalMu (Total Keys: 2)
The following keys were changed:
- endpoints (Total Keys: 1)
---
...s.keyRings.cryptoKeys.cryptoKeyVersions.html | 1 +
.../discovery_cache/documents/cloudkms.v1.json | 17 +++++++++++------
2 files changed, 12 insertions(+), 6 deletions(-)
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 651b184cc80..2fb9907ca8a 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/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json
index dfd7902a7bc..32ec5969df2 100644
--- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json
@@ -61,11 +61,6 @@
},
{
"description": "Regional Endpoint",
-"endpointUrl": "https://cloudkms.us-east7.rep.googleapis.com/",
-"location": "us-east7"
-},
-{
-"description": "Regional Endpoint",
"endpointUrl": "https://cloudkms.us-central1.rep.googleapis.com/",
"location": "us-central1"
},
@@ -101,6 +96,11 @@
},
{
"description": "Regional Endpoint",
+"endpointUrl": "https://cloudkms.us-east7.rep.googleapis.com/",
+"location": "us-east7"
+},
+{
+"description": "Regional Endpoint",
"endpointUrl": "https://cloudkms.us.rep.googleapis.com/",
"location": "us"
},
@@ -2938,7 +2938,7 @@
}
}
},
-"revision": "20260206",
+"revision": "20260213",
"rootUrl": "https://cloudkms.googleapis.com/",
"schemas": {
"AddQuorumMember": {
@@ -3952,6 +3952,11 @@
"description": "A Digest holds a cryptographic message digest.",
"id": "Digest",
"properties": {
+"externalMu": {
+"description": "A message digest produced with SHAKE-256, to be used with ML-DSA external-\u03bc 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",
+"format": "byte",
+"type": "string"
+},
"sha256": {
"description": "A message digest produced with the SHA-256 algorithm.",
"format": "byte",
From 8390b91e2904dae9b316b3db5a7474fcd33f6224 Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 24 Feb 2026 07:27:55 +0000
Subject: [PATCH 05/29] feat(compute): update the api
#### compute:alpha
The following keys were deleted:
- schemas.AttachedDisk.properties.userLicenses (Total Keys: 3)
- schemas.Disk.properties.userLicenses (Total Keys: 2)
- schemas.Image.properties.userLicenses (Total Keys: 2)
- schemas.RecoverableSnapshotOriginalSnapshot.properties.userLicenses (Total Keys: 2)
- schemas.Snapshot.properties.userLicenses (Total Keys: 2)
- schemas.VmExtensionState.properties.unhealthyMsg.type (Total Keys: 1)
The following keys were added:
- resources.reservationSubBlocks.methods.get.parameters.parentName.pattern (Total Keys: 1)
- resources.reservationSubBlocks.methods.getVersion.parameters.parentName.pattern (Total Keys: 1)
- resources.reservationSubBlocks.methods.list.parameters.parentName.pattern (Total Keys: 1)
- resources.reservationSubBlocks.methods.performMaintenance.parameters.parentName.pattern (Total Keys: 1)
- resources.reservationSubBlocks.methods.reportFaulty.parameters.parentName.pattern (Total Keys: 1)
- schemas.VmExtensionState.properties.healthMsg.type (Total Keys: 1)
The following keys were changed:
- resources.reservationSubBlocks.methods.get (Total Keys: 2)
- resources.reservationSubBlocks.methods.getVersion (Total Keys: 2)
- resources.reservationSubBlocks.methods.list (Total Keys: 2)
- resources.reservationSubBlocks.methods.performMaintenance (Total Keys: 2)
- resources.reservationSubBlocks.methods.reportFaulty (Total Keys: 2)
#### compute:beta
The following keys were deleted:
- schemas.AttachedDisk.properties.userLicenses (Total Keys: 3)
- schemas.Disk.properties.userLicenses (Total Keys: 2)
- schemas.Image.properties.userLicenses (Total Keys: 2)
- schemas.Snapshot.properties.userLicenses (Total Keys: 2)
The following keys were added:
- resources.instanceGroupManagers.methods.configureAcceleratorTopologies (Total Keys: 20)
- resources.reservationSubBlocks.methods.get.parameters.parentName.pattern (Total Keys: 1)
- resources.reservationSubBlocks.methods.list.parameters.parentName.pattern (Total Keys: 1)
- resources.reservationSubBlocks.methods.performMaintenance.parameters.parentName.pattern (Total Keys: 1)
- resources.reservationSubBlocks.methods.reportFaulty.parameters.parentName.pattern (Total Keys: 1)
- resources.routers.methods.deleteNamedSet (Total Keys: 23)
- resources.routers.methods.getNamedSet (Total Keys: 20)
- resources.routers.methods.listNamedSets (Total Keys: 32)
- resources.routers.methods.patchNamedSet (Total Keys: 22)
- resources.routers.methods.updateNamedSet (Total Keys: 22)
- resources.snapshotGroups.methods.delete (Total Keys: 17)
- resources.snapshotGroups.methods.get (Total Keys: 33)
- resources.snapshotGroups.methods.insert (Total Keys: 14)
- resources.snapshotGroups.methods.list (Total Keys: 24)
- resources.snapshotGroups.methods.setIamPolicy (Total Keys: 16)
- resources.snapshotGroups.methods.testIamPermissions (Total Keys: 16)
- schemas.Backend.properties.orchestrationInfo.$ref (Total Keys: 1)
- schemas.BackendBackendOrchestrationInfo (Total Keys: 3)
- schemas.BackendService.properties.orchestrationInfo.$ref (Total Keys: 1)
- schemas.BackendServiceOrchestrationInfo (Total Keys: 3)
- schemas.BulkInsertDiskResource.properties.snapshotGroupParameters.$ref (Total Keys: 1)
- schemas.InstanceGroupManagersConfigureAcceleratorTopologiesRequest (Total Keys: 4)
- schemas.InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse.properties.multiMig.type (Total Keys: 1)
- schemas.InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo.properties.acceleratorTopologyState.$ref (Total Keys: 1)
- schemas.InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo.properties.instancesHealth.type (Total Keys: 1)
- schemas.InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo.properties.parent.type (Total Keys: 1)
- schemas.InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyState (Total Keys: 17)
- schemas.ListSnapshotGroups (Total Keys: 21)
- schemas.LocationPolicy.properties.zones (Total Keys: 2)
- schemas.LocationPolicyZoneConfiguration (Total Keys: 3)
- schemas.NamedSet (Total Keys: 8)
- schemas.Reservation.properties.params.$ref (Total Keys: 1)
- schemas.ReservationParams (Total Keys: 4)
- schemas.RoutersGetNamedSetResponse (Total Keys: 3)
- schemas.RoutersListNamedSets (Total Keys: 21)
- schemas.Snapshot.properties.snapshotGroupId (Total Keys: 2)
- schemas.Snapshot.properties.snapshotGroupName (Total Keys: 2)
- schemas.SnapshotGroup (Total Keys: 41)
The following keys were changed:
- resources.reservationSubBlocks.methods.get (Total Keys: 2)
- resources.reservationSubBlocks.methods.getIamPolicy (Total Keys: 2)
- resources.reservationSubBlocks.methods.list (Total Keys: 2)
- resources.reservationSubBlocks.methods.performMaintenance (Total Keys: 2)
- resources.reservationSubBlocks.methods.reportFaulty (Total Keys: 2)
- resources.reservationSubBlocks.methods.setIamPolicy (Total Keys: 2)
- resources.reservationSubBlocks.methods.testIamPermissions (Total Keys: 2)
#### compute:v1
The following keys were added:
- resources.regionHealthAggregationPolicies.methods.aggregatedList (Total Keys: 29)
- resources.regionHealthAggregationPolicies.methods.delete (Total Keys: 21)
- resources.regionHealthAggregationPolicies.methods.get (Total Keys: 19)
- resources.regionHealthAggregationPolicies.methods.insert (Total Keys: 18)
- resources.regionHealthAggregationPolicies.methods.list (Total Keys: 28)
- resources.regionHealthAggregationPolicies.methods.patch (Total Keys: 21)
- resources.regionHealthAggregationPolicies.methods.testIamPermissions (Total Keys: 20)
- resources.reservationSubBlocks.methods.get.parameters.parentName.pattern (Total Keys: 1)
- resources.reservationSubBlocks.methods.list.parameters.parentName.pattern (Total Keys: 1)
- resources.reservationSubBlocks.methods.performMaintenance.parameters.parentName.pattern (Total Keys: 1)
- resources.reservationSubBlocks.methods.reportFaulty.parameters.parentName.pattern (Total Keys: 1)
- schemas.Backend.properties.orchestrationInfo.$ref (Total Keys: 1)
- schemas.BackendBackendOrchestrationInfo (Total Keys: 3)
- schemas.BackendService.properties.orchestrationInfo.$ref (Total Keys: 1)
- schemas.BackendServiceOrchestrationInfo (Total Keys: 3)
- schemas.ExternalVpnGateway.properties.params.$ref (Total Keys: 1)
- schemas.ExternalVpnGatewayParams (Total Keys: 4)
- schemas.HealthAggregationPoliciesScopedList (Total Keys: 11)
- schemas.HealthAggregationPolicy (Total Keys: 63)
- schemas.LocationPolicy.properties.zones (Total Keys: 2)
- schemas.LocationPolicyZoneConfiguration (Total Keys: 3)
- schemas.Reservation.properties.params.$ref (Total Keys: 1)
- schemas.ReservationParams (Total Keys: 4)
- schemas.ResourceStatusEffectiveInstanceMetadata.properties.gceContainerDeclarationMetadataValue.type (Total Keys: 1)
- schemas.TargetVpnGateway.properties.params.$ref (Total Keys: 1)
- schemas.TargetVpnGatewayParams (Total Keys: 4)
- schemas.VpnGateway.properties.params.$ref (Total Keys: 1)
- schemas.VpnGatewayParams (Total Keys: 4)
- schemas.VpnTunnel.properties.params.$ref (Total Keys: 1)
- schemas.VpnTunnelParams (Total Keys: 4)
The following keys were changed:
- resources.reservationSubBlocks.methods.get (Total Keys: 2)
- resources.reservationSubBlocks.methods.getIamPolicy (Total Keys: 2)
- resources.reservationSubBlocks.methods.list (Total Keys: 2)
- resources.reservationSubBlocks.methods.performMaintenance (Total Keys: 2)
- resources.reservationSubBlocks.methods.reportFaulty (Total Keys: 2)
- resources.reservationSubBlocks.methods.setIamPolicy (Total Keys: 2)
- resources.reservationSubBlocks.methods.testIamPermissions (Total Keys: 2)
---
docs/dyn/compute_alpha.disks.html | 58 +-
...mpute_alpha.globalVmExtensionPolicies.html | 6 +-
docs/dyn/compute_alpha.imageFamilyViews.html | 10 +-
docs/dyn/compute_alpha.images.html | 50 +-
.../compute_alpha.instanceGroupManagers.html | 110 +-
docs/dyn/compute_alpha.instanceTemplates.html | 36 +-
docs/dyn/compute_alpha.instances.html | 89 +-
docs/dyn/compute_alpha.machineImages.html | 27 +-
.../compute_alpha.recoverableSnapshots.html | 12 -
docs/dyn/compute_alpha.regionDisks.html | 49 +-
...ute_alpha.regionInstanceGroupManagers.html | 94 +-
...compute_alpha.regionInstanceTemplates.html | 27 +-
docs/dyn/compute_alpha.regionInstances.html | 31 +-
...pute_alpha.regionRecoverableSnapshots.html | 8 -
docs/dyn/compute_alpha.regionSnapshots.html | 18 +-
docs/dyn/compute_alpha.snapshots.html | 24 +-
.../compute_alpha.zoneQueuedResources.html | 124 +-
...compute_alpha.zoneVmExtensionPolicies.html | 24 +-
docs/dyn/compute_beta.backendServices.html | 63 +
docs/dyn/compute_beta.disks.html | 78 +-
...ompute_beta.globalVmExtensionPolicies.html | 6 +-
docs/dyn/compute_beta.html | 5 +
docs/dyn/compute_beta.imageFamilyViews.html | 10 +-
docs/dyn/compute_beta.images.html | 50 +-
.../compute_beta.instanceGroupManagers.html | 463 +-
docs/dyn/compute_beta.instanceTemplates.html | 36 +-
docs/dyn/compute_beta.instances.html | 85 +-
docs/dyn/compute_beta.machineImages.html | 27 +-
.../compute_beta.regionBackendServices.html | 54 +
docs/dyn/compute_beta.regionCommitments.html | 72 +
docs/dyn/compute_beta.regionDisks.html | 69 +-
...pute_beta.regionInstanceGroupManagers.html | 52 +-
.../compute_beta.regionInstanceTemplates.html | 27 +-
docs/dyn/compute_beta.regionInstances.html | 33 +-
docs/dyn/compute_beta.regionSnapshots.html | 27 +-
docs/dyn/compute_beta.reservations.html | 60 +
docs/dyn/compute_beta.routers.html | 5366 ++++++++++-------
docs/dyn/compute_beta.snapshotGroups.html | 2218 +++++++
docs/dyn/compute_beta.snapshots.html | 36 +-
.../compute_beta.zoneVmExtensionPolicies.html | 24 +-
docs/dyn/compute_v1.backendServices.html | 63 +
docs/dyn/compute_v1.disks.html | 14 +-
docs/dyn/compute_v1.externalVpnGateways.html | 57 +
docs/dyn/compute_v1.html | 5 +
docs/dyn/compute_v1.imageFamilyViews.html | 2 +-
docs/dyn/compute_v1.images.html | 10 +-
docs/dyn/compute_v1.instanceTemplates.html | 16 +-
docs/dyn/compute_v1.instances.html | 50 +-
docs/dyn/compute_v1.machineImages.html | 12 +-
.../dyn/compute_v1.regionBackendServices.html | 54 +
docs/dyn/compute_v1.regionCommitments.html | 60 +
docs/dyn/compute_v1.regionDisks.html | 13 +-
...te_v1.regionHealthAggregationPolicies.html | 1658 +++++
.../compute_v1.regionInstanceTemplates.html | 12 +-
docs/dyn/compute_v1.regionInstances.html | 23 +-
docs/dyn/compute_v1.reservations.html | 60 +
docs/dyn/compute_v1.snapshots.html | 6 +-
docs/dyn/compute_v1.targetVpnGateways.html | 76 +
docs/dyn/compute_v1.vpnGateways.html | 76 +
docs/dyn/compute_v1.vpnTunnels.html | 76 +
.../documents/compute.alpha.json | 99 +-
.../documents/compute.beta.json | 1665 ++++-
.../discovery_cache/documents/compute.v1.json | 1720 ++++--
63 files changed, 11777 insertions(+), 3708 deletions(-)
create mode 100644 docs/dyn/compute_beta.snapshotGroups.html
create mode 100644 docs/dyn/compute_v1.regionHealthAggregationPolicies.html
diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html
index e421082b936..6bd0b18e96f 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 030a0827c11..ac80c01a400 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 fe649d4998d..7721935a8ab 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",
- ],
},
}
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 b252820d81a..044a19303c8 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 00f58febb0f..6659d635a26 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 9f9efe2c5fd..4f30e57285e 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 b4a8d3fb0ea..215e0c4ed11 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 e638d8ec378..b79a8a28c4f 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", - ], }
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 5d437f86e82..9c53b32783c 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 ece4c85f42e..37fb413b2db 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 843604ba712..3289f237e2d 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 da35af6342a..ecb47eddfa4 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 511185e8c36..d64f02ba11d 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 0ecee48fb2c..c89284dcb29 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 925758b1d06..91452d19452 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 5eb4fa02fe5..cca4a00d9a7 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 00000000000..df5f2353c8c
--- /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 5ba9709cabb..91c28aace49 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 c81a372213d..46e2307004f 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 e50fe3ac7f0..497df85fd4b 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 00000000000..a9f7d1ac315 --- /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 13154466e7e..bf988ed4290 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 f117f8674ac..2e56a65519b 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 b374a41550b..7ac235a2dd1 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 567d8ca2d6d..b7d049228cf 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 bc78bc01542..0f663646179 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 c4fe05087e0..0f102033704 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 40ad85a87cb..5e53dc40f96 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/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 62a96244031..1961d61a1d6 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -4010,7 +4010,7 @@ ] }, "update": { -"description": "Updates the specified disk with the data included in the request.\nThe update is performed only on selected fields included as part\nof update-mask. Only the following fields can be modified: user_license.", +"description": "Updates the specified disk with the data included in the request.\nThe update is performed only on selected fields included as part\nof update-mask.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}", "httpMethod": "PATCH", "id": "compute.disks.update", @@ -30130,7 +30130,7 @@ ] }, "update": { -"description": "Update the specified disk with the data included in the request. Update is\nperformed only on selected fields included as part of update-mask. Only the\nfollowing fields can be modified: user_license.", +"description": "Update the specified disk with the data included in the request. Update is\nperformed only on selected fields included as part of update-mask.", "flatPath": "projects/{project}/regions/{region}/disks/{disk}", "httpMethod": "PATCH", "id": "compute.regionDisks.update", @@ -41530,7 +41530,7 @@ "methods": { "get": { "description": "Retrieves information about the specified reservation subBlock.", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}", "httpMethod": "GET", "id": "compute.reservationSubBlocks.get", "parameterOrder": [ @@ -41543,6 +41543,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -41580,7 +41581,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}", "response": { "$ref": "ReservationSubBlocksGetResponse" }, @@ -41592,7 +41593,7 @@ }, "getVersion": { "description": "Allows customers to get SBOM versions of a reservation subBlock.", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/getVersion", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/getVersion", "httpMethod": "POST", "id": "compute.reservationSubBlocks.getVersion", "parameterOrder": [ @@ -41605,6 +41606,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -41632,7 +41634,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/getVersion", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/getVersion", "request": { "$ref": "ReservationSubBlocksGetVersionRequest" }, @@ -41646,7 +41648,7 @@ }, "list": { "description": "Retrieves a list of reservation subBlocks under a single reservation.", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks", "httpMethod": "GET", "id": "compute.reservationSubBlocks.list", "parameterOrder": [ @@ -41681,6 +41683,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -41702,7 +41705,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks", "response": { "$ref": "ReservationSubBlocksListResponse" }, @@ -41714,7 +41717,7 @@ }, "performMaintenance": { "description": "Allows customers to perform maintenance on a reservation subBlock", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", "httpMethod": "POST", "id": "compute.reservationSubBlocks.performMaintenance", "parameterOrder": [ @@ -41727,6 +41730,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -41754,7 +41758,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", "response": { "$ref": "Operation" }, @@ -41765,7 +41769,7 @@ }, "reportFaulty": { "description": "Allows customers to report a faulty subBlock.", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", "httpMethod": "POST", "id": "compute.reservationSubBlocks.reportFaulty", "parameterOrder": [ @@ -41778,6 +41782,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -41805,7 +41810,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", "request": { "$ref": "ReservationSubBlocksReportFaultyRequest" }, @@ -54659,7 +54664,7 @@ } } }, -"revision": "20260206", +"revision": "20260213", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -56570,14 +56575,6 @@ false "" ], "type": "string" -}, -"userLicenses": { -"description": "Output only. [Output Only] A list of user provided licenses. It represents a list of\nURLs to the license resource. Unlike regular licenses, user provided\nlicenses can be modified after the disk is created.", -"items": { -"type": "string" -}, -"readOnly": true, -"type": "array" } }, "type": "object" @@ -56704,7 +56701,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when\nempty.", +"description": "Input only. Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when\nempty.", "type": "object" }, "resourcePolicies": { @@ -63758,13 +63755,6 @@ false "description": "URL of the disk type resource describing which disk type to use to create\nthe disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk\ntypes.", "type": "string" }, -"userLicenses": { -"description": "A list of publicly visible user-licenses. Unlike regular licenses, user\nprovided licenses can be modified after the disk is created. This includes\na list of URLs to the license resource. For example, to provide a debian\nlicense:\n\nhttps://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch", -"items": { -"type": "string" -}, -"type": "array" -}, "users": { "description": "Output only. [Output Only] Links to the users of the disk (attached instances)\nin form:projects/project/zones/zone/instances/instance", "items": { @@ -64263,7 +64253,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" } }, @@ -74849,13 +74839,6 @@ false "type": "string" }, "type": "array" -}, -"userLicenses": { -"description": "A list of publicly visible user-licenses. Unlike regular licenses, user\nprovided licenses can be modified after the disk is created. This includes\na list of URLs to the license resource. For example, to provide a debian\nlicense:\n\nhttps://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch", -"items": { -"type": "string" -}, -"type": "array" } }, "type": "object" @@ -75035,7 +75018,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the image. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the image. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" } }, @@ -76971,7 +76954,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to bind to the managed instance group. The tags are\nkey-value pairs. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. For more information, seeManage tags\nfor resources.", +"description": "Input only. Resource manager tags to bind to the managed instance group. The tags are\nkey-value pairs. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. For more information, seeManage tags\nfor resources.", "type": "object" } }, @@ -79518,7 +79501,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" } }, @@ -79661,7 +79644,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and\nvalues are in the format `tagValues/456`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and\nvalues are in the format `tagValues/456`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" }, "resourcePolicies": { @@ -87366,7 +87349,7 @@ false "additionalProperties": { "$ref": "LocationPolicyLocation" }, -"description": "Location configurations mapped by location name.\nCurrently only zone names are supported and must be represented as valid\ninternal URLs, such as zones/us-central1-a.", +"description": "Location configurations mapped by location name.\nCurrently only zone names are supported and must be represented as valid\ninternal URLs, such as zones/us-central1-a.\nThe bulkInsert operation doesn't create instances in an AI zone, even if\nan AI zone is available in the specified region. For example, if you set a\nDENY preference for us-central1-a, Compute Engine will consider\nus-central1-b and us-central1-c for instance creation, but not\nus-central1-ai1a. Also, you can't use the locations[] configuration to\nallow instance creation in an AI zone. To include an AI zone in bulkInsert\noperations, use the locationPolicy.zones[] field.", "type": "object" }, "targetShape": { @@ -87384,7 +87367,7 @@ false "type": "string" }, "zones": { -"description": "List with zones where bulk will create instances.", +"description": "The bulkInsert operation applies any preferences set in the locations\nfield to the specific zones listed in the zones field if the same zones\nare specified in both fields.", "items": { "$ref": "LocationPolicyZoneConfiguration" }, @@ -87440,7 +87423,7 @@ false "id": "LocationPolicyZoneConfiguration", "properties": { "zone": { -"description": "The URL of thezone.\nThe zone must exist in the region where the request is called.\nZones must be represented as valid internal URLs,\nsuch as zones/us-central1-a.", +"description": "The URL of the zone.\nThe zone must exist in the region where the request is called.\nZones must be represented as valid partial URLs,\nsuch as zones/us-central1-a.", "type": "string" } }, @@ -102348,13 +102331,6 @@ false "type": "string" }, "type": "array" -}, -"userLicenses": { -"description": "[Output Only] A list of user provided licenses represented by a list of\nURLs to the license resource.", -"items": { -"type": "string" -}, -"type": "array" } }, "type": "object" @@ -115375,13 +115351,6 @@ false "type": "string" }, "type": "array" -}, -"userLicenses": { -"description": "[Output Only] A list of user provided licenses represented by a list of\nURLs to the license resource.", -"items": { -"type": "string" -}, -"type": "array" } }, "type": "object" @@ -115848,7 +115817,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the snapshot. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" } }, @@ -126238,7 +126207,7 @@ false "additionalProperties": { "$ref": "VmExtensionPolicyExtensionPolicy" }, -"description": "Required. A map of extension names (e.g., \"cloudops\") to their corresponding policy\nconfigurations.", +"description": "Required. A map of extension names (for example, \"ops-agent\") to their corresponding\npolicy configurations.", "type": "object" }, "globalResourceLink": { @@ -126281,7 +126250,7 @@ false "type": "string" }, "priority": { -"description": "Optional. Priority of this policy. Used to resolve conflicts when multiple policies\napply to the same extension.\nThe policy priority is an integer from 0 to 65535, inclusive. Lower\nintegers indicate higher priorities. If you do not specify a priority when\ncreating a rule, it is assigned a priority of 1000. If priorities are\nequal, the policy with the more recent creation timestamp takes precedence.", +"description": "Optional. Priority of this policy. Used to resolve conflicts when multiple policies\napply to the same extension.\nThe policy priority is an integer from 0 to 65535, inclusive. Lower\nintegers indicate higher priorities. If you do not specify a priority when\ncreating a rule, it is assigned a priority of 1000. If priorities are\nequal, the policy with the most recent creation timestamp takes precedence.", "format": "int32", "type": "integer" }, @@ -126738,6 +126707,10 @@ false ], "type": "string" }, +"healthMsg": { +"description": "The health status message of the extension.", +"type": "string" +}, "healthStatus": { "description": "The health status of the extension.", "enum": [ @@ -126766,10 +126739,6 @@ false "description": "The id of the policy that is enforced on the extension.", "type": "string" }, -"unhealthyMsg": { -"description": "The status message of the extension if the extension is in unhealthy\nstate.", -"type": "string" -}, "version": { "description": "The version of the extension.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 083601de2d0..efe62ce1ec3 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -3882,7 +3882,7 @@ ] }, "update": { -"description": "Updates the specified disk with the data included in the request.\nThe update is performed only on selected fields included as part\nof update-mask. Only the following fields can be modified: user_license.", +"description": "Updates the specified disk with the data included in the request.\nThe update is performed only on selected fields included as part\nof update-mask.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}", "httpMethod": "PATCH", "id": "compute.disks.update", @@ -9661,6 +9661,54 @@ "https://www.googleapis.com/auth/compute" ] }, +"configureAcceleratorTopologies": { +"description": "Updates the accelerator topologies configuration.", +"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/configureAcceleratorTopologies", +"httpMethod": "POST", +"id": "compute.instanceGroupManagers.configureAcceleratorTopologies", +"parameterOrder": [ +"project", +"zone", +"instanceGroupManager" +], +"parameters": { +"instanceGroupManager": { +"description": "The name of the managed instance group.\nIt should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"zone": { +"description": "The name of thezone\nwhere the managed instance group is located.\nIt should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/configureAcceleratorTopologies", +"request": { +"$ref": "InstanceGroupManagersConfigureAcceleratorTopologiesRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "createInstances": { "description": "Creates instances with per-instance configurations in this managed instance\ngroup. Instances are created using the current instance template. Thecreate instances operation is marked DONE if thecreateInstances request is successful. The underlying actions\ntake additional time. You must separately verify the status of thecreating or actions with the listmanagedinstances\nmethod.", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances", @@ -27943,7 +27991,7 @@ ] }, "update": { -"description": "Update the specified disk with the data included in the request. Update is\nperformed only on selected fields included as part of update-mask. Only the\nfollowing fields can be modified: user_license.", +"description": "Update the specified disk with the data included in the request. Update is\nperformed only on selected fields included as part of update-mask.", "flatPath": "projects/{project}/regions/{region}/disks/{disk}", "httpMethod": "PATCH", "id": "compute.regionDisks.update", @@ -38687,7 +38735,7 @@ "methods": { "get": { "description": "Retrieves information about the specified reservation subBlock.", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}", "httpMethod": "GET", "id": "compute.reservationSubBlocks.get", "parameterOrder": [ @@ -38700,6 +38748,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -38737,7 +38786,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}", "response": { "$ref": "ReservationSubBlocksGetResponse" }, @@ -38749,7 +38798,7 @@ }, "getIamPolicy": { "description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", -"flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/getIamPolicy", "httpMethod": "GET", "id": "compute.reservationSubBlocks.getIamPolicy", "parameterOrder": [ @@ -38794,7 +38843,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy", +"path": "projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -38806,7 +38855,7 @@ }, "list": { "description": "Retrieves a list of reservation subBlocks under a single reservation.", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks", "httpMethod": "GET", "id": "compute.reservationSubBlocks.list", "parameterOrder": [ @@ -38841,6 +38890,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -38862,7 +38912,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks", "response": { "$ref": "ReservationSubBlocksListResponse" }, @@ -38874,7 +38924,7 @@ }, "performMaintenance": { "description": "Allows customers to perform maintenance on a reservation subBlock", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", "httpMethod": "POST", "id": "compute.reservationSubBlocks.performMaintenance", "parameterOrder": [ @@ -38887,6 +38937,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -38914,7 +38965,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", "response": { "$ref": "Operation" }, @@ -38925,7 +38976,7 @@ }, "reportFaulty": { "description": "Allows customers to report a faulty subBlock.", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", "httpMethod": "POST", "id": "compute.reservationSubBlocks.reportFaulty", "parameterOrder": [ @@ -38938,6 +38989,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -38965,7 +39017,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", "request": { "$ref": "ReservationSubBlocksReportFaultyRequest" }, @@ -38979,7 +39031,7 @@ }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", -"flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/setIamPolicy", "httpMethod": "POST", "id": "compute.reservationSubBlocks.setIamPolicy", "parameterOrder": [ @@ -39018,7 +39070,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy", +"path": "projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/setIamPolicy", "request": { "$ref": "ZoneSetNestedPolicyRequest" }, @@ -39032,7 +39084,7 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/testIamPermissions", "httpMethod": "POST", "id": "compute.reservationSubBlocks.testIamPermissions", "parameterOrder": [ @@ -39071,7 +39123,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions", +"path": "projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -40570,6 +40622,58 @@ "https://www.googleapis.com/auth/compute" ] }, +"deleteNamedSet": { +"description": "Deletes Named Set", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/deleteNamedSet", +"httpMethod": "POST", +"id": "compute.routers.deleteNamedSet", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"namedSet": { +"description": "The Named Set name for this request. Name must conform to RFC1035", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"router": { +"description": "Name of the Router resource where Named Set is defined.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/deleteNamedSet", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "deleteRoutePolicy": { "description": "Deletes Route Policy", "flatPath": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", @@ -40665,6 +40769,53 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getNamedSet": { +"description": "Returns specified Named Set", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/getNamedSet", +"httpMethod": "GET", +"id": "compute.routers.getNamedSet", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"namedSet": { +"description": "The Named Set name for this request. Name must conform to RFC1035", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"router": { +"description": "Name of the Router resource to query for the named set. The name should\nconform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/getNamedSet", +"response": { +"$ref": "RoutersGetNamedSetResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "getNatIpInfo": { "description": "Retrieves runtime NAT IP information.", "flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo", @@ -41102,11 +41253,11 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"listRoutePolicies": { -"description": "Retrieves a list of router route policy subresources available to the\nspecified project.", -"flatPath": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies", +"listNamedSets": { +"description": "Retrieves a list of router named set subresources available to the\nspecified project.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/listNamedSets", "httpMethod": "GET", -"id": "compute.routers.listRoutePolicies", +"id": "compute.routers.listNamedSets", "parameterOrder": [ "project", "region", @@ -41163,9 +41314,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies", +"path": "projects/{project}/regions/{region}/routers/{router}/listNamedSets", "response": { -"$ref": "RoutersListRoutePolicies" +"$ref": "RoutersListNamedSets" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -41173,17 +41324,40 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"patch": { -"description": "Patches the specified Router resource with the data included in the\nrequest. This method supportsPATCH\nsemantics and usesJSON merge\npatch format and processing rules.", -"flatPath": "projects/{project}/regions/{region}/routers/{router}", -"httpMethod": "PATCH", -"id": "compute.routers.patch", +"listRoutePolicies": { +"description": "Retrieves a list of router route policy subresources available to the\nspecified project.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies", +"httpMethod": "GET", +"id": "compute.routers.listRoutePolicies", "parameterOrder": [ "project", "region", "router" ], "parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -41198,36 +41372,34 @@ "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", "location": "query", -"type": "string" +"type": "boolean" }, "router": { -"description": "Name of the Router resource to patch.", +"description": "Name or id of the resource for this request.\nName should conform to RFC1035.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/routers/{router}", -"request": { -"$ref": "Router" -}, +"path": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies", "response": { -"$ref": "Operation" +"$ref": "RoutersListRoutePolicies" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" ] }, -"patchRoutePolicy": { -"description": "Patches Route Policy", -"flatPath": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy", -"httpMethod": "POST", -"id": "compute.routers.patchRoutePolicy", +"patch": { +"description": "Patches the specified Router resource with the data included in the\nrequest. This method supportsPATCH\nsemantics and usesJSON merge\npatch format and processing rules.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}", +"httpMethod": "PATCH", +"id": "compute.routers.patch", "parameterOrder": [ "project", "region", @@ -41254,16 +41426,16 @@ "type": "string" }, "router": { -"description": "Name of the Router resource where Route Policy is defined.", +"description": "Name of the Router resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy", +"path": "projects/{project}/regions/{region}/routers/{router}", "request": { -"$ref": "RoutePolicy" +"$ref": "Router" }, "response": { "$ref": "Operation" @@ -41273,11 +41445,11 @@ "https://www.googleapis.com/auth/compute" ] }, -"preview": { -"description": "Preview fields auto-generated during router create andupdate operations.\nCalling this method does NOT create or update the router.", -"flatPath": "projects/{project}/regions/{region}/routers/{router}/preview", +"patchNamedSet": { +"description": "Patches Named Set", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/patchNamedSet", "httpMethod": "POST", -"id": "compute.routers.preview", +"id": "compute.routers.patchNamedSet", "parameterOrder": [ "project", "region", @@ -41298,78 +41470,178 @@ "required": true, "type": "string" }, -"router": { -"description": "Name of the Router resource to query.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/routers/{router}/preview", -"request": { -"$ref": "Router" -}, -"response": { -"$ref": "RoutersPreviewResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/regions/{region}/routers/{resource}/testIamPermissions", -"httpMethod": "POST", -"id": "compute.routers.testIamPermissions", -"parameterOrder": [ -"project", -"region", -"resource" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "The name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", "type": "string" }, -"resource": { -"description": "Name or id of the resource for this request.", +"router": { +"description": "Name of the Router resource where Named Set is defined.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" } }, -"path": "projects/{project}/regions/{region}/routers/{resource}/testIamPermissions", +"path": "projects/{project}/regions/{region}/routers/{router}/patchNamedSet", "request": { -"$ref": "TestPermissionsRequest" +"$ref": "NamedSet" }, "response": { -"$ref": "TestPermissionsResponse" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, -"update": { -"description": "Updates the specified Router resource with the data included in the\nrequest. This method conforms toPUT semantics, which requests that the state of the\ntarget resource be created or replaced with the state defined by the\nrepresentation enclosed in the request message payload.", -"flatPath": "projects/{project}/regions/{region}/routers/{router}", -"httpMethod": "PUT", -"id": "compute.routers.update", +"patchRoutePolicy": { +"description": "Patches Route Policy", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy", +"httpMethod": "POST", +"id": "compute.routers.patchRoutePolicy", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"router": { +"description": "Name of the Router resource where Route Policy is defined.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy", +"request": { +"$ref": "RoutePolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"preview": { +"description": "Preview fields auto-generated during router create andupdate operations.\nCalling this method does NOT create or update the router.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/preview", +"httpMethod": "POST", +"id": "compute.routers.preview", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"router": { +"description": "Name of the Router resource to query.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/preview", +"request": { +"$ref": "Router" +}, +"response": { +"$ref": "RoutersPreviewResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/routers/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.routers.testIamPermissions", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, +"response": { +"$ref": "TestPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"update": { +"description": "Updates the specified Router resource with the data included in the\nrequest. This method conforms toPUT semantics, which requests that the state of the\ntarget resource be created or replaced with the state defined by the\nrepresentation enclosed in the request message payload.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}", +"httpMethod": "PUT", +"id": "compute.routers.update", "parameterOrder": [ "project", "region", @@ -41415,6 +41687,56 @@ "https://www.googleapis.com/auth/compute" ] }, +"updateNamedSet": { +"description": "Updates or creates new Named Set", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/updateNamedSet", +"httpMethod": "POST", +"id": "compute.routers.updateNamedSet", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"router": { +"description": "Name of the Router resource where Named Set is defined.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/updateNamedSet", +"request": { +"$ref": "NamedSet" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "updateRoutePolicy": { "description": "Updates or creates new Route Policy", "flatPath": "projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy", @@ -42723,15 +43045,55 @@ } } }, -"snapshotSettings": { +"snapshotGroups": { "methods": { +"delete": { +"description": "Deletes the specified SnapshotGroup resource", +"flatPath": "projects/{project}/global/snapshotGroups/{snapshotGroup}", +"httpMethod": "DELETE", +"id": "compute.snapshotGroups.delete", +"parameterOrder": [ +"project", +"snapshotGroup" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"snapshotGroup": { +"description": "Name of the SnapshotGroup resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/snapshotGroups/{snapshotGroup}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "get": { -"description": "Get snapshot settings.", -"flatPath": "projects/{project}/global/snapshotSettings", +"description": "returns the specified SnapshotGroup resource.", +"flatPath": "projects/{project}/global/snapshotGroups/{snapshotGroup}", "httpMethod": "GET", -"id": "compute.snapshotSettings.get", +"id": "compute.snapshotGroups.get", "parameterOrder": [ -"project" +"project", +"snapshotGroup" ], "parameters": { "project": { @@ -42740,11 +43102,18 @@ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, "type": "string" +}, +"snapshotGroup": { +"description": "Name of the SnapshotGroup resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" } }, -"path": "projects/{project}/global/snapshotSettings", +"path": "projects/{project}/global/snapshotGroups/{snapshotGroup}", "response": { -"$ref": "SnapshotSettings" +"$ref": "SnapshotGroup" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -42752,11 +43121,52 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"patch": { -"description": "Patch snapshot settings.", -"flatPath": "projects/{project}/global/snapshotSettings", -"httpMethod": "PATCH", -"id": "compute.snapshotSettings.patch", +"getIamPolicy": { +"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", +"flatPath": "projects/{project}/global/snapshotGroups/{resource}/getIamPolicy", +"httpMethod": "GET", +"id": "compute.snapshotGroups.getIamPolicy", +"parameterOrder": [ +"project", +"resource" +], +"parameters": { +"optionsRequestedPolicyVersion": { +"description": "Requested IAM Policy version.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/snapshotGroups/{resource}/getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a snapshot group in the specified project using the data included\nin the request.", +"flatPath": "projects/{project}/global/snapshotGroups", +"httpMethod": "POST", +"id": "compute.snapshotGroups.insert", "parameterOrder": [ "project" ], @@ -42772,17 +43182,11 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" -}, -"updateMask": { -"description": "update_mask indicates fields to be updated as part of this request.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "projects/{project}/global/snapshotSettings", +"path": "projects/{project}/global/snapshotGroups", "request": { -"$ref": "SnapshotSettings" +"$ref": "SnapshotGroup" }, "response": { "$ref": "Operation" @@ -42791,16 +43195,12 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] -} -} }, -"snapshots": { -"methods": { -"aggregatedList": { -"description": "Retrieves an aggregated list of all of the snapshots in your project\nacross all regions and global scope.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", -"flatPath": "projects/{project}/aggregated/snapshots", +"list": { +"description": "retrieves the list of SnapshotGroup resources contained within\nthe specified project.", +"flatPath": "projects/{project}/global/snapshotGroups", "httpMethod": "GET", -"id": "compute.snapshots.aggregatedList", +"id": "compute.snapshotGroups.list", "parameterOrder": [ "project" ], @@ -42810,11 +43210,216 @@ "location": "query", "type": "string" }, -"includeAllScopes": { -"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", -"location": "query", -"type": "boolean" -}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/global/snapshotGroups", +"response": { +"$ref": "ListSnapshotGroups" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", +"flatPath": "projects/{project}/global/snapshotGroups/{resource}/setIamPolicy", +"httpMethod": "POST", +"id": "compute.snapshotGroups.setIamPolicy", +"parameterOrder": [ +"project", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/snapshotGroups/{resource}/setIamPolicy", +"request": { +"$ref": "GlobalSetPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/global/snapshotGroups/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.snapshotGroups.testIamPermissions", +"parameterOrder": [ +"project", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/snapshotGroups/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, +"response": { +"$ref": "TestPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, +"snapshotSettings": { +"methods": { +"get": { +"description": "Get snapshot settings.", +"flatPath": "projects/{project}/global/snapshotSettings", +"httpMethod": "GET", +"id": "compute.snapshotSettings.get", +"parameterOrder": [ +"project" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/snapshotSettings", +"response": { +"$ref": "SnapshotSettings" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"patch": { +"description": "Patch snapshot settings.", +"flatPath": "projects/{project}/global/snapshotSettings", +"httpMethod": "PATCH", +"id": "compute.snapshotSettings.patch", +"parameterOrder": [ +"project" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "update_mask indicates fields to be updated as part of this request.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/global/snapshotSettings", +"request": { +"$ref": "SnapshotSettings" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, +"snapshots": { +"methods": { +"aggregatedList": { +"description": "Retrieves an aggregated list of all of the snapshots in your project\nacross all regions and global scope.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/snapshots", +"httpMethod": "GET", +"id": "compute.snapshots.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", +"location": "query", +"type": "boolean" +}, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", @@ -50445,7 +51050,7 @@ } } }, -"revision": "20260206", +"revision": "20260213", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -52275,14 +52880,6 @@ false "" ], "type": "string" -}, -"userLicenses": { -"description": "Output only. [Output Only] A list of user provided licenses. It represents a list of\nURLs to the license resource. Unlike regular licenses, user provided\nlicenses can be modified after the disk is created.", -"items": { -"type": "string" -}, -"readOnly": true, -"type": "array" } }, "type": "object" @@ -52386,7 +52983,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when\nempty.", +"description": "Input only. Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when\nempty.", "type": "object" }, "resourcePolicies": { @@ -53389,6 +53986,10 @@ false "format": "float", "type": "number" }, +"orchestrationInfo": { +"$ref": "BackendBackendOrchestrationInfo", +"description": "Information about the resource or system that manages the backend." +}, "preference": { "description": "This field indicates whether this backend should be fully utilized before\nsending traffic to backends with default preference. The possible values\nare:\n \n - PREFERRED: Backends with this preference level will be\n filled up to their capacity limits first, based on RTT.\n - DEFAULT: If preferred backends don't have enough\n capacity, backends in this layer would be used and traffic would be\n assigned based on the load balancing algorithm you use. This is the\n default", "enum": [ @@ -53419,6 +54020,17 @@ false }, "type": "object" }, +"BackendBackendOrchestrationInfo": { +"description": "A message containing information about the resource or system that manages\nthe backend.", +"id": "BackendBackendOrchestrationInfo", +"properties": { +"resourceUri": { +"description": "The URI of the resource or system that manages the backend.", +"type": "string" +} +}, +"type": "object" +}, "BackendBucket": { "description": "Represents a Cloud Storage Bucket resource.\n\nThis Cloud Storage bucket resource is referenced by a URL map of a load\nbalancer. For more information, readBackend Buckets.", "id": "BackendBucket", @@ -54542,6 +55154,10 @@ false "$ref": "BackendServiceNetworkPassThroughLbTrafficPolicy", "description": "Configures traffic steering properties of internal passthrough Network\nLoad Balancers.\n\nnetworkPassThroughLbTrafficPolicy cannot be specified with haPolicy." }, +"orchestrationInfo": { +"$ref": "BackendServiceOrchestrationInfo", +"description": "Information about the resource or system that manages the backend service." +}, "outlierDetection": { "$ref": "OutlierDetection", "description": "Settings controlling the ejection of unhealthy backend endpoints from the\nload balancing pool of each individual proxy instance that processes the\ntraffic for the given backend service. If not set, this feature is\nconsidered disabled.\n\nResults of the outlier detection algorithm (ejection of endpoints from the\nload balancing pool and returning them back to the pool) are executed\nindependently by each proxy instance of the load balancer. In most cases,\nmore than one proxy instance handles the traffic received by a backend\nservice. Thus, it is possible that an unhealthy endpoint is detected and\nejected by only some of the proxies, and while this happens, other proxies\nmay continue to send requests to the same unhealthy endpoint until they\ndetect and eject the unhealthy endpoint.\n\nApplicable backend endpoints can be:\n \n - VM instances in an Instance Group\n - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)\n - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)\n - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud\n Functions Services \n - Private Service Connect NEGs, that resolve to\n Google-managed regional API endpoints or managed services published using\n Private Service Connect\n\n\n\nApplicable backend service types can be:\n \n - A global backend service with the loadBalancingScheme set to\n INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. \n - A regional backend\n service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and\n loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not\n supported for Serverless NEGs.\n\n\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true." @@ -55608,6 +56224,17 @@ false }, "type": "object" }, +"BackendServiceOrchestrationInfo": { +"description": "A message containing information about the resource or system that manages\nthe backend service.", +"id": "BackendServiceOrchestrationInfo", +"properties": { +"resourceUri": { +"description": "The resource URI of the resource or system that manages the backend\nservice.", +"type": "string" +} +}, +"type": "object" +}, "BackendServiceParams": { "description": "Additional Backend Service parameters.", "id": "BackendServiceParams", @@ -56206,6 +56833,10 @@ false "$ref": "InstantSnapshotGroupParameters", "description": "The parameters for the instant snapshot group." }, +"snapshotGroupParameters": { +"$ref": "SnapshotGroupParameters", +"description": "The parameters for the snapshot group." +}, "sourceConsistencyGroupPolicy": { "description": "The URL of the DiskConsistencyGroupPolicy for the group of disks to clone.\nThis may be a full or partial URL, such as:\n \n \n - \n https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy\n \n - \n projects/project/regions/region/resourcePolicies/resourcePolicy\n \n - \n regions/region/resourcePolicies/resourcePolicy", "type": "string" @@ -58672,13 +59303,6 @@ false "description": "URL of the disk type resource describing which disk type to use to create\nthe disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk\ntypes.", "type": "string" }, -"userLicenses": { -"description": "A list of publicly visible user-licenses. Unlike regular licenses, user\nprovided licenses can be modified after the disk is created. This includes\na list of URLs to the license resource. For example, to provide a debian\nlicense:\n\nhttps://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch", -"items": { -"type": "string" -}, -"type": "array" -}, "users": { "description": "Output only. [Output Only] Links to the users of the disk (attached instances)\nin form:projects/project/zones/zone/instances/instance", "items": { @@ -59114,7 +59738,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" } }, @@ -67780,13 +68404,6 @@ false "type": "string" }, "type": "array" -}, -"userLicenses": { -"description": "A list of publicly visible user-licenses. Unlike regular licenses, user\nprovided licenses can be modified after the disk is created. This includes\na list of URLs to the license resource. For example, to provide a debian\nlicense:\n\nhttps://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch", -"items": { -"type": "string" -}, -"type": "array" } }, "type": "object" @@ -67966,7 +68583,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the image. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the image. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" } }, @@ -69774,7 +70391,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to bind to the managed instance group. The tags are\nkey-value pairs. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. For more information, seeManage tags\nfor resources.", +"description": "Input only. Resource manager tags to bind to the managed instance group. The tags are\nkey-value pairs. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. For more information, seeManage tags\nfor resources.", "type": "object" } }, @@ -70657,6 +71274,30 @@ false }, "type": "object" }, +"InstanceGroupManagersConfigureAcceleratorTopologiesRequest": { +"description": "InstanceGroupManagers.ConfigureAcceleratorTopologies", +"id": "InstanceGroupManagersConfigureAcceleratorTopologiesRequest", +"properties": { +"acceleratorTopologyActions": { +"additionalProperties": { +"enum": [ +"ACCELERATOR_TOPOLOGY_ACTION_UNSPECIFIED", +"ACTIVATE", +"DEACTIVATE" +], +"enumDescriptions": [ +"Default value. Should not be used.", +"The accelerator topology is to be activated.", +"The accelerator topology is to be deactivated." +], +"type": "string" +}, +"description": "Map of accelerator topologies that should have their state changed to\nthe specified value. The key is the hashed topology locus id. It can be\nobtained from the GetAvailableAcceleratorTopologies rpc.", +"type": "object" +} +}, +"type": "object" +}, "InstanceGroupManagersCreateInstancesRequest": { "description": "InstanceGroupManagers.createInstances", "id": "InstanceGroupManagersCreateInstancesRequest", @@ -70711,6 +71352,10 @@ false }, "description": "The accelerator topology information returned per id of the topology\nlocation.", "type": "object" +}, +"multiMig": { +"description": "URL to MMIG this MIG belongs to.", +"type": "string" } }, "type": "object" @@ -70726,14 +71371,115 @@ false "enum": [ "DEGRADED", "HEALTHY", -"UNHEALTHY" +"UNHEALTHY", +"UNKNOWN" ], "enumDescriptions": [ "All VM are in RUNNING state, but there is an issue with\nthe inter-chip connectivity that makes this part\nof the infrastructure ready to use as a working\ninter-chip connected group only in a degraded mode.\nThis is allowed only for Instances configured with ICI\nresiliency", "All VM are in RUNNING state, there are no issues with the\ninter-chip connectivity.", -"Some VMs may not be in RUNNING state, or there is an\nissue with the inter-chip connectivity that makes this\npart of the infrastructure unsuitable for forming a\nworking inter-chip connected group." +"Some VMs may not be in RUNNING state, or there is an\nissue with the inter-chip connectivity that makes this\npart of the infrastructure unsuitable for forming a\nworking inter-chip connected group.", +"No signal available" +], +"type": "string" +}, +"acceleratorTopologyState": { +"$ref": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyState" +}, +"instancesHealth": { +"enum": [ +"ALL_HEALTHY", +"UNHEALTHY_OR_MISSING" +], +"enumDescriptions": [ +"Infrastructure is healthy", +"Some VMs are in another state than RUNNING or they are missing." +], +"type": "string" +}, +"parent": { +"description": "Identified by the topology Id in the accelerator_topology_info map. Empty\nfor the top-level topology", +"type": "string" +} +}, +"type": "object" +}, +"InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyState": { +"description": "Specifies the topology state", +"id": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyState", +"properties": { +"currentState": { +"enum": [ +"ACTIVATING", +"ACTIVE", +"ACTIVE_DEGRADED", +"DEACTIVATING", +"FAILED", +"INACTIVE", +"INCOMPLETE" +], +"enumDescriptions": [ +"", +"", +"The topology is active but with potential performance degradation.", +"", +"Critical non-retriable error that the user has to act manually", +"", +"Not all VMs have been provisioned" ], "type": "string" +}, +"error": { +"description": "Reason why the topology state change failed", +"properties": { +"errors": { +"description": "[Output Only] The array of errors encountered while processing this\noperation.", +"items": { +"properties": { +"code": { +"description": "[Output Only] The error type identifier for this error.", +"type": "string" +}, +"errorDetails": { +"description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.", +"items": { +"properties": { +"errorInfo": { +"$ref": "ErrorInfo" +}, +"help": { +"$ref": "Help" +}, +"localizedMessage": { +"$ref": "LocalizedMessage" +}, +"quotaInfo": { +"$ref": "QuotaExceededInfo" +} +}, +"type": "object" +}, +"type": "array" +}, +"location": { +"description": "[Output Only] Indicates the field in the request that caused the error.\nThis property is optional.", +"type": "string" +}, +"message": { +"description": "[Output Only] An optional, human-readable error message.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, +"errorTimestamp": { +"description": "Timestamp when the last error happened", +"format": "google-datetime", +"type": "string" } }, "type": "object" @@ -72005,7 +72751,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" } }, @@ -72140,7 +72886,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and\nvalues are in the format `tagValues/456`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and\nvalues are in the format `tagValues/456`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" }, "resourcePolicies": { @@ -78479,6 +79225,174 @@ false }, "type": "object" }, +"ListSnapshotGroups": { +"description": "Contains a list of SnapshotGroup resources.", +"id": "ListSnapshotGroups", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of SnapshotGroup resources.", +"items": { +"$ref": "SnapshotGroup" +}, +"type": "array" +}, +"kind": { +"default": "compute#snapshotGroupsList", +"description": "Output only. Type of resource.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "LocalDisk": { "id": "LocalDisk", "properties": { @@ -78522,7 +79436,7 @@ false "additionalProperties": { "$ref": "LocationPolicyLocation" }, -"description": "Location configurations mapped by location name.\nCurrently only zone names are supported and must be represented as valid\ninternal URLs, such as zones/us-central1-a.", +"description": "Location configurations mapped by location name.\nCurrently only zone names are supported and must be represented as valid\ninternal URLs, such as zones/us-central1-a.\nThe bulkInsert operation doesn't create instances in an AI zone, even if\nan AI zone is available in the specified region. For example, if you set a\nDENY preference for us-central1-a, Compute Engine will consider\nus-central1-b and us-central1-c for instance creation, but not\nus-central1-ai1a. Also, you can't use the locations[] configuration to\nallow instance creation in an AI zone. To include an AI zone in bulkInsert\noperations, use the locationPolicy.zones[] field.", "type": "object" }, "targetShape": { @@ -78538,6 +79452,13 @@ false "GCE prioritizes acquisition of resources, scheduling VMs in zones\nwhere resources are available while distributing VMs as evenly as\npossible across allowed zones to minimize the impact of zonal failure.\nRecommended for highly available serving workloads." ], "type": "string" +}, +"zones": { +"description": "The bulkInsert operation applies any preferences set in the locations\nfield to the specific zones listed in the zones field if the same zones\nare specified in both fields.", +"items": { +"$ref": "LocationPolicyZoneConfiguration" +}, +"type": "array" } }, "type": "object" @@ -78578,6 +79499,16 @@ false }, "type": "object" }, +"LocationPolicyZoneConfiguration": { +"id": "LocationPolicyZoneConfiguration", +"properties": { +"zone": { +"description": "The URL of the zone.\nThe zone must exist in the region where the request is called.\nZones must be represented as valid partial URLs,\nsuch as zones/us-central1-a.", +"type": "string" +} +}, +"type": "object" +}, "MachineImage": { "description": "Represents a machine image resource.\n\nA machine image is a Compute Engine resource that stores all the\nconfiguration, metadata, permissions, and data from one or more disks\nrequired to create a Virtual machine (VM) instance. For more information, seeMachine images.", "id": "MachineImage", @@ -80420,6 +81351,44 @@ false }, "type": "object" }, +"NamedSet": { +"id": "NamedSet", +"properties": { +"description": { +"description": "An optional description of named set.", +"type": "string" +}, +"elements": { +"description": "CEL expressions that are comparable to constructs of this set's type\n(see Policy Language).", +"items": { +"$ref": "Expr" +}, +"type": "array" +}, +"fingerprint": { +"description": "A fingerprint for the Named Set being applied to this Router, which is\nessentially a hash of the Named Set used for optimistic locking.\nThe fingerprint is initially generated by Compute Engine and changes\nafter every request to modify or update the Named Set. You must always\nprovide an up-to-date fingerprint hash in order to update or change\nlabels.\n\nTo see the latest fingerprint, make a getNamedSet() request\nto retrieve a Named Set.", +"format": "byte", +"type": "string" +}, +"name": { +"description": "This set's name, which must be a resource ID segment and unique within all\nnamed sets owned by the Router. Name should conform to RFC1035.", +"type": "string" +}, +"type": { +"description": "This named set's type", +"enum": [ +"NAMED_SET_TYPE_COMMUNITY", +"NAMED_SET_TYPE_PREFIX" +], +"enumDescriptions": [ +"The Named Set is a Community Named Set.", +"The Named Set is a Prefix Named Set." +], +"type": "string" +} +}, +"type": "object" +}, "NatIpInfo": { "description": "Contains NAT IP information of a NAT config (i.e. usage status, mode).", "id": "NatIpInfo", @@ -93347,6 +94316,10 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"params": { +"$ref": "ReservationParams", +"description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload." +}, "protectionTier": { "description": "Protection tier for the workload which specifies the workload expectations\nin the event of infrastructure failures at data center (e.g. power\nand/or cooling failures).", "enum": [ @@ -94195,6 +95168,20 @@ false }, "type": "object" }, +"ReservationParams": { +"description": "Additional reservation params.", +"id": "ReservationParams", +"properties": { +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Input only. Resource manager tags to be bound to the reservation. Tag keys and\nvalues have the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"type": "object" +} +}, +"type": "object" +}, "ReservationSlot": { "description": "Represents a reservation slot resource.", "id": "ReservationSlot", @@ -94247,13 +95234,15 @@ false "ACTIVE", "CREATING", "DELETING", -"STATE_UNSPECIFIED" +"STATE_UNSPECIFIED", +"UNAVAILABLE" ], "enumDescriptions": [ "The reservation slot has allocated all its resources.", "The resources are being allocated for the reservation slot.", "The reservation slot is currently being deleted.", -"" +"", +"The reservation slot is currently unavailable." ], "readOnly": true, "type": "string" @@ -98981,6 +99970,19 @@ false }, "type": "object" }, +"RoutersGetNamedSetResponse": { +"id": "RoutersGetNamedSetResponse", +"properties": { +"etag": { +"description": "end_interface: MixerGetResponseWithEtagBuilder", +"type": "string" +}, +"resource": { +"$ref": "NamedSet" +} +}, +"type": "object" +}, "RoutersGetRoutePolicyResponse": { "id": "RoutersGetRoutePolicyResponse", "properties": { @@ -99157,6 +100159,173 @@ false }, "type": "object" }, +"RoutersListNamedSets": { +"id": "RoutersListNamedSets", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"type": "string" +}, +"kind": { +"default": "compute#routersListNamedSets", +"description": "Output only. [Output Only] Type of resource. Alwayscompute#routersListNamedSets for lists of named sets.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"result": { +"description": "[Output Only] A list of named sets.", +"items": { +"$ref": "NamedSet" +}, +"type": "array" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "RoutersListRoutePolicies": { "id": "RoutersListRoutePolicies", "properties": { @@ -102683,6 +103852,16 @@ false "$ref": "CustomerEncryptionKey", "description": "Encrypts the snapshot using acustomer-supplied\nencryption key.\n\nAfter you encrypt a snapshot using a customer-supplied key, you must\nprovide the same key if you use the snapshot later. For example, you must\nprovide the encryption key when you create a disk from the encrypted\nsnapshot in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata\nof the snapshot.\n\nIf you do not provide an encryption key when creating the snapshot, then\nthe snapshot will be encrypted using an automatically generated key and you\ndo not need to provide a key to use the snapshot later." }, +"snapshotGroupId": { +"description": "Output only. [Output Only] The unique ID of the snapshot group that this snapshot\nbelongs to.", +"readOnly": true, +"type": "string" +}, +"snapshotGroupName": { +"description": "Output only. [Output only] The snapshot group that this snapshot belongs to.", +"readOnly": true, +"type": "string" +}, "snapshotType": { "description": "Indicates the type of the snapshot.", "enum": [ @@ -102779,13 +103958,6 @@ false "type": "string" }, "type": "array" -}, -"userLicenses": { -"description": "[Output Only] A list of user provided licenses represented by a list of\nURLs to the license resource.", -"items": { -"type": "string" -}, -"type": "array" } }, "type": "object" @@ -102958,6 +104130,135 @@ false }, "type": "object" }, +"SnapshotGroup": { +"description": "Represents a SnapshotGroup resource.\n\nA snapshot group is a set of snapshots that represents a point in time state\nof a consistency group.", +"id": "SnapshotGroup", +"properties": { +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. An optional description of this resource. Provide this property when you\ncreate the resource.", +"type": "string" +}, +"id": { +"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"kind": { +"default": "compute#snapshotGroup", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#snapshotGroup for SnapshotGroup\nresources.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for the resource.", +"readOnly": true, +"type": "string" +}, +"selfLinkWithId": { +"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.", +"readOnly": true, +"type": "string" +}, +"sourceInfo": { +"$ref": "SnapshotGroupSourceInfo", +"description": "Output only. [Output Only]", +"readOnly": true +}, +"sourceInstantSnapshotGroup": { +"description": "Input field for the source instant snapshot group.", +"type": "string" +}, +"sourceInstantSnapshotGroupInfo": { +"$ref": "SnapshotGroupSourceInstantSnapshotGroupInfo", +"description": "Output only. [Output Only]", +"readOnly": true +}, +"status": { +"description": "Output only. [Output Only]", +"enum": [ +"CREATING", +"DELETING", +"FAILED", +"INVALID", +"READY", +"UNKNOWN", +"UPLOADING" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SnapshotGroupParameters": { +"id": "SnapshotGroupParameters", +"properties": { +"replicaZones": { +"description": "URLs of the zones where disks should be replicated to. Only applicable\nfor regional resources.", +"items": { +"type": "string" +}, +"type": "array" +}, +"sourceSnapshotGroup": { +"description": "The source snapshot group used to create disks. You can provide this as a\npartial or full URL to the resource. For example, the following are valid\nvalues:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/global/snapshotGroups/snapshotGroup \n - projects/project/global/snapshotGroups/snapshotGroup\n - global/snapshotGroups/snapshotGroup", +"type": "string" +}, +"type": { +"description": "URL of the disk type resource describing which disk type to use to create\ndisks. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk\ntypes.", +"type": "string" +} +}, +"type": "object" +}, +"SnapshotGroupSourceInfo": { +"id": "SnapshotGroupSourceInfo", +"properties": { +"consistencyGroup": { +"readOnly": true, +"type": "string" +}, +"consistencyGroupId": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SnapshotGroupSourceInstantSnapshotGroupInfo": { +"id": "SnapshotGroupSourceInstantSnapshotGroupInfo", +"properties": { +"instantSnapshotGroup": { +"readOnly": true, +"type": "string" +}, +"instantSnapshotGroupId": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "SnapshotList": { "description": "Contains a list of Snapshot resources.", "id": "SnapshotList", @@ -103123,7 +104424,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the snapshot. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" } }, @@ -113106,7 +114407,7 @@ false "additionalProperties": { "$ref": "VmExtensionPolicyExtensionPolicy" }, -"description": "Required. A map of extension names (e.g., \"cloudops\") to their corresponding policy\nconfigurations.", +"description": "Required. A map of extension names (for example, \"ops-agent\") to their corresponding\npolicy configurations.", "type": "object" }, "globalResourceLink": { @@ -113149,7 +114450,7 @@ false "type": "string" }, "priority": { -"description": "Optional. Priority of this policy. Used to resolve conflicts when multiple policies\napply to the same extension.\nThe policy priority is an integer from 0 to 65535, inclusive. Lower\nintegers indicate higher priorities. If you do not specify a priority when\ncreating a rule, it is assigned a priority of 1000. If priorities are\nequal, the policy with the more recent creation timestamp takes precedence.", +"description": "Optional. Priority of this policy. Used to resolve conflicts when multiple policies\napply to the same extension.\nThe policy priority is an integer from 0 to 65535, inclusive. Lower\nintegers indicate higher priorities. If you do not specify a priority when\ncreating a rule, it is assigned a priority of 1000. If priorities are\nequal, the policy with the most recent creation timestamp takes precedence.", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index b9a8cc3d659..66fa83b9e22 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -3671,7 +3671,7 @@ ] }, "update": { -"description": "Updates the specified disk with the data included in the request.\nThe update is performed only on selected fields included as part\nof update-mask. Only the following fields can be modified: user_license.", +"description": "Updates the specified disk with the data included in the request.\nThe update is performed only on selected fields included as part\nof update-mask.", "flatPath": "projects/{project}/zones/{zone}/disks/{disk}", "httpMethod": "PATCH", "id": "compute.disks.update", @@ -25122,7 +25122,7 @@ ] }, "update": { -"description": "Update the specified disk with the data included in the request. Update is\nperformed only on selected fields included as part of update-mask. Only the\nfollowing fields can be modified: user_license.", +"description": "Update the specified disk with the data included in the request. Update is\nperformed only on selected fields included as part of update-mask.", "flatPath": "projects/{project}/regions/{region}/disks/{disk}", "httpMethod": "PATCH", "id": "compute.regionDisks.update", @@ -25184,22 +25184,89 @@ } } }, -"regionHealthCheckServices": { +"regionHealthAggregationPolicies": { "methods": { +"aggregatedList": { +"description": "Retrieves the list of all HealthAggregationPolicy resources,\nregional and global, available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/healthAggregationPolicies", +"httpMethod": "GET", +"id": "compute.regionHealthAggregationPolicies.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", +"location": "query", +"type": "boolean" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Name of the project scoping this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"serviceProjectNumber": { +"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/aggregated/healthAggregationPolicies", +"response": { +"$ref": "HealthAggregationPolicyAggregatedList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "delete": { -"description": "Deletes the specified regional HealthCheckService.", -"flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", +"description": "Deletes the specified HealthAggregationPolicy in the given region.", +"flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}", "httpMethod": "DELETE", -"id": "compute.regionHealthCheckServices.delete", +"id": "compute.regionHealthAggregationPolicies.delete", "parameterOrder": [ "project", "region", -"healthCheckService" +"healthAggregationPolicy" ], "parameters": { -"healthCheckService": { -"description": "Name of the HealthCheckService to delete. The name\nmust be 1-63 characters long, and comply with RFC1035.", +"healthAggregationPolicy": { +"description": "Name of the HealthAggregationPolicy resource to delete.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -25223,7 +25290,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", +"path": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}", "response": { "$ref": "Operation" }, @@ -25233,19 +25300,20 @@ ] }, "get": { -"description": "Returns the specified regional HealthCheckService resource.", -"flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", +"description": "Returns the specified HealthAggregationPolicy resource in the given region.", +"flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}", "httpMethod": "GET", -"id": "compute.regionHealthCheckServices.get", +"id": "compute.regionHealthAggregationPolicies.get", "parameterOrder": [ "project", "region", -"healthCheckService" +"healthAggregationPolicy" ], "parameters": { -"healthCheckService": { -"description": "Name of the HealthCheckService to update. The name\nmust be 1-63 characters long, and comply with RFC1035.", +"healthAggregationPolicy": { +"description": "Name of the HealthAggregationPolicy resource to return.", "location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -25264,9 +25332,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", +"path": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}", "response": { -"$ref": "HealthCheckService" +"$ref": "HealthAggregationPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -25275,10 +25343,10 @@ ] }, "insert": { -"description": "Creates a regional HealthCheckService resource in the\nspecified project and region using the data included in the request.", -"flatPath": "projects/{project}/regions/{region}/healthCheckServices", +"description": "Create a HealthAggregationPolicy in the specified project in the given\nregion using the parameters that are included in the request.", +"flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies", "httpMethod": "POST", -"id": "compute.regionHealthCheckServices.insert", +"id": "compute.regionHealthAggregationPolicies.insert", "parameterOrder": [ "project", "region" @@ -25304,9 +25372,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/healthCheckServices", +"path": "projects/{project}/regions/{region}/healthAggregationPolicies", "request": { -"$ref": "HealthCheckService" +"$ref": "HealthAggregationPolicy" }, "response": { "$ref": "Operation" @@ -25317,10 +25385,10 @@ ] }, "list": { -"description": "Lists all the HealthCheckService resources that have been\nconfigured for the specified project in the given region.", -"flatPath": "projects/{project}/regions/{region}/healthCheckServices", +"description": "Lists the HealthAggregationPolicies for a project in the given region.", +"flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies", "httpMethod": "GET", -"id": "compute.regionHealthCheckServices.list", +"id": "compute.regionHealthAggregationPolicies.list", "parameterOrder": [ "project", "region" @@ -25369,9 +25437,9 @@ "type": "boolean" } }, -"path": "projects/{project}/regions/{region}/healthCheckServices", +"path": "projects/{project}/regions/{region}/healthAggregationPolicies", "response": { -"$ref": "HealthCheckServicesList" +"$ref": "HealthAggregationPolicyList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -25380,18 +25448,18 @@ ] }, "patch": { -"description": "Updates the specified regional HealthCheckService resource\nwith the data included in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.", -"flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", +"description": "Updates the specified regional HealthAggregationPolicy\nresource with the data included in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.", +"flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}", "httpMethod": "PATCH", -"id": "compute.regionHealthCheckServices.patch", +"id": "compute.regionHealthAggregationPolicies.patch", "parameterOrder": [ "project", "region", -"healthCheckService" +"healthAggregationPolicy" ], "parameters": { -"healthCheckService": { -"description": "Name of the HealthCheckService to update. The name\nmust be 1-63 characters long, and comply with RFC1035.", +"healthAggregationPolicy": { +"description": "Name of the HealthAggregationPolicy to update. The name\nmust be 1-63 characters long, and comply with RFC1035.", "location": "path", "required": true, "type": "string" @@ -25416,9 +25484,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", +"path": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}", "request": { -"$ref": "HealthCheckService" +"$ref": "HealthAggregationPolicy" }, "response": { "$ref": "Operation" @@ -25430,9 +25498,9 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions", +"flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions", "httpMethod": "POST", -"id": "compute.regionHealthCheckServices.testIamPermissions", +"id": "compute.regionHealthAggregationPolicies.testIamPermissions", "parameterOrder": [ "project", "region", @@ -25461,7 +25529,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions", +"path": "projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -25476,23 +25544,22 @@ } } }, -"regionHealthChecks": { +"regionHealthCheckServices": { "methods": { "delete": { -"description": "Deletes the specified HealthCheck resource.", -"flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", +"description": "Deletes the specified regional HealthCheckService.", +"flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "httpMethod": "DELETE", -"id": "compute.regionHealthChecks.delete", +"id": "compute.regionHealthCheckServices.delete", "parameterOrder": [ "project", "region", -"healthCheck" +"healthCheckService" ], "parameters": { -"healthCheck": { -"description": "Name of the HealthCheck resource to delete.", +"healthCheckService": { +"description": "Name of the HealthCheckService to delete. The name\nmust be 1-63 characters long, and comply with RFC1035.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -25516,7 +25583,7 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", +"path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "response": { "$ref": "Operation" }, @@ -25526,20 +25593,19 @@ ] }, "get": { -"description": "Returns the specified HealthCheck resource.", -"flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", +"description": "Returns the specified regional HealthCheckService resource.", +"flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "httpMethod": "GET", -"id": "compute.regionHealthChecks.get", +"id": "compute.regionHealthCheckServices.get", "parameterOrder": [ "project", "region", -"healthCheck" +"healthCheckService" ], "parameters": { -"healthCheck": { -"description": "Name of the HealthCheck resource to return.", +"healthCheckService": { +"description": "Name of the HealthCheckService to update. The name\nmust be 1-63 characters long, and comply with RFC1035.", "location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" }, @@ -25558,9 +25624,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", +"path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "response": { -"$ref": "HealthCheck" +"$ref": "HealthCheckService" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -25569,10 +25635,10 @@ ] }, "insert": { -"description": "Creates a HealthCheck resource in the specified project using the data\nincluded in the request.", -"flatPath": "projects/{project}/regions/{region}/healthChecks", +"description": "Creates a regional HealthCheckService resource in the\nspecified project and region using the data included in the request.", +"flatPath": "projects/{project}/regions/{region}/healthCheckServices", "httpMethod": "POST", -"id": "compute.regionHealthChecks.insert", +"id": "compute.regionHealthCheckServices.insert", "parameterOrder": [ "project", "region" @@ -25598,9 +25664,9 @@ "type": "string" } }, -"path": "projects/{project}/regions/{region}/healthChecks", +"path": "projects/{project}/regions/{region}/healthCheckServices", "request": { -"$ref": "HealthCheck" +"$ref": "HealthCheckService" }, "response": { "$ref": "Operation" @@ -25611,10 +25677,10 @@ ] }, "list": { -"description": "Retrieves the list of HealthCheck resources available to the specified\nproject.", -"flatPath": "projects/{project}/regions/{region}/healthChecks", +"description": "Lists all the HealthCheckService resources that have been\nconfigured for the specified project in the given region.", +"flatPath": "projects/{project}/regions/{region}/healthCheckServices", "httpMethod": "GET", -"id": "compute.regionHealthChecks.list", +"id": "compute.regionHealthCheckServices.list", "parameterOrder": [ "project", "region" @@ -25663,9 +25729,9 @@ "type": "boolean" } }, -"path": "projects/{project}/regions/{region}/healthChecks", +"path": "projects/{project}/regions/{region}/healthCheckServices", "response": { -"$ref": "HealthCheckList" +"$ref": "HealthCheckServicesList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -25674,10 +25740,109 @@ ] }, "patch": { -"description": "Updates a HealthCheck resource in the specified project using the data\nincluded in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.", -"flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", +"description": "Updates the specified regional HealthCheckService resource\nwith the data included in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.", +"flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", "httpMethod": "PATCH", -"id": "compute.regionHealthChecks.patch", +"id": "compute.regionHealthCheckServices.patch", +"parameterOrder": [ +"project", +"region", +"healthCheckService" +], +"parameters": { +"healthCheckService": { +"description": "Name of the HealthCheckService to update. The name\nmust be 1-63 characters long, and comply with RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}", +"request": { +"$ref": "HealthCheckService" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.regionHealthCheckServices.testIamPermissions", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, +"response": { +"$ref": "TestPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, +"regionHealthChecks": { +"methods": { +"delete": { +"description": "Deletes the specified HealthCheck resource.", +"flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", +"httpMethod": "DELETE", +"id": "compute.regionHealthChecks.delete", "parameterOrder": [ "project", "region", @@ -25685,7 +25850,202 @@ ], "parameters": { "healthCheck": { -"description": "Name of the HealthCheck resource to patch.", +"description": "Name of the HealthCheck resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Returns the specified HealthCheck resource.", +"flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", +"httpMethod": "GET", +"id": "compute.regionHealthChecks.get", +"parameterOrder": [ +"project", +"region", +"healthCheck" +], +"parameters": { +"healthCheck": { +"description": "Name of the HealthCheck resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", +"response": { +"$ref": "HealthCheck" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a HealthCheck resource in the specified project using the data\nincluded in the request.", +"flatPath": "projects/{project}/regions/{region}/healthChecks", +"httpMethod": "POST", +"id": "compute.regionHealthChecks.insert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/healthChecks", +"request": { +"$ref": "HealthCheck" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Retrieves the list of HealthCheck resources available to the specified\nproject.", +"flatPath": "projects/{project}/regions/{region}/healthChecks", +"httpMethod": "GET", +"id": "compute.regionHealthChecks.list", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions/{region}/healthChecks", +"response": { +"$ref": "HealthCheckList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"patch": { +"description": "Updates a HealthCheck resource in the specified project using the data\nincluded in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.", +"flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}", +"httpMethod": "PATCH", +"id": "compute.regionHealthChecks.patch", +"parameterOrder": [ +"project", +"region", +"healthCheck" +], +"parameters": { +"healthCheck": { +"description": "Name of the HealthCheck resource to patch.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -32407,7 +32767,7 @@ "methods": { "get": { "description": "Retrieves information about the specified reservation subBlock.", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}", "httpMethod": "GET", "id": "compute.reservationSubBlocks.get", "parameterOrder": [ @@ -32420,6 +32780,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -32457,7 +32818,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}", "response": { "$ref": "ReservationSubBlocksGetResponse" }, @@ -32469,7 +32830,7 @@ }, "getIamPolicy": { "description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", -"flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/getIamPolicy", "httpMethod": "GET", "id": "compute.reservationSubBlocks.getIamPolicy", "parameterOrder": [ @@ -32514,7 +32875,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy", +"path": "projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/getIamPolicy", "response": { "$ref": "Policy" }, @@ -32526,7 +32887,7 @@ }, "list": { "description": "Retrieves a list of reservation subBlocks under a single reservation.", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks", "httpMethod": "GET", "id": "compute.reservationSubBlocks.list", "parameterOrder": [ @@ -32561,6 +32922,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -32582,7 +32944,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks", "response": { "$ref": "ReservationSubBlocksListResponse" }, @@ -32594,7 +32956,7 @@ }, "performMaintenance": { "description": "Allows customers to perform maintenance on a reservation subBlock", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", "httpMethod": "POST", "id": "compute.reservationSubBlocks.performMaintenance", "parameterOrder": [ @@ -32607,6 +32969,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -32634,7 +32997,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance", "response": { "$ref": "Operation" }, @@ -32645,7 +33008,7 @@ }, "reportFaulty": { "description": "Allows customers to report a faulty subBlock.", -"flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", "httpMethod": "POST", "id": "compute.reservationSubBlocks.reportFaulty", "parameterOrder": [ @@ -32658,6 +33021,7 @@ "parentName": { "description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}", "location": "path", +"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$", "required": true, "type": "string" }, @@ -32685,7 +33049,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", +"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty", "request": { "$ref": "ReservationSubBlocksReportFaultyRequest" }, @@ -32699,7 +33063,7 @@ }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", -"flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/setIamPolicy", "httpMethod": "POST", "id": "compute.reservationSubBlocks.setIamPolicy", "parameterOrder": [ @@ -32738,7 +33102,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy", +"path": "projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/setIamPolicy", "request": { "$ref": "ZoneSetNestedPolicyRequest" }, @@ -32752,7 +33116,7 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", -"flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions", +"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/testIamPermissions", "httpMethod": "POST", "id": "compute.reservationSubBlocks.testIamPermissions", "parameterOrder": [ @@ -32791,7 +33155,7 @@ "type": "string" } }, -"path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions", +"path": "projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/testIamPermissions", "request": { "$ref": "TestPermissionsRequest" }, @@ -43142,7 +43506,7 @@ } } }, -"revision": "20260206", +"revision": "20260213", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -45023,7 +45387,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when\nempty.", +"description": "Input only. Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when\nempty.", "type": "object" }, "resourcePolicies": { @@ -45984,6 +46348,10 @@ false "format": "float", "type": "number" }, +"orchestrationInfo": { +"$ref": "BackendBackendOrchestrationInfo", +"description": "Information about the resource or system that manages the backend." +}, "preference": { "description": "This field indicates whether this backend should be fully utilized before\nsending traffic to backends with default preference. The possible values\nare:\n \n - PREFERRED: Backends with this preference level will be\n filled up to their capacity limits first, based on RTT.\n - DEFAULT: If preferred backends don't have enough\n capacity, backends in this layer would be used and traffic would be\n assigned based on the load balancing algorithm you use. This is the\n default", "enum": [ @@ -46001,6 +46369,17 @@ false }, "type": "object" }, +"BackendBackendOrchestrationInfo": { +"description": "A message containing information about the resource or system that manages\nthe backend.", +"id": "BackendBackendOrchestrationInfo", +"properties": { +"resourceUri": { +"description": "The URI of the resource or system that manages the backend.", +"type": "string" +} +}, +"type": "object" +}, "BackendBucket": { "description": "Represents a Cloud Storage Bucket resource.\n\nThis Cloud Storage bucket resource is referenced by a URL map of a load\nbalancer. For more information, readBackend Buckets.", "id": "BackendBucket", @@ -46663,6 +47042,10 @@ false "$ref": "BackendServiceNetworkPassThroughLbTrafficPolicy", "description": "Configures traffic steering properties of internal passthrough Network\nLoad Balancers.\n\nnetworkPassThroughLbTrafficPolicy cannot be specified with haPolicy." }, +"orchestrationInfo": { +"$ref": "BackendServiceOrchestrationInfo", +"description": "Information about the resource or system that manages the backend service." +}, "outlierDetection": { "$ref": "OutlierDetection", "description": "Settings controlling the ejection of unhealthy backend endpoints from the\nload balancing pool of each individual proxy instance that processes the\ntraffic for the given backend service. If not set, this feature is\nconsidered disabled.\n\nResults of the outlier detection algorithm (ejection of endpoints from the\nload balancing pool and returning them back to the pool) are executed\nindependently by each proxy instance of the load balancer. In most cases,\nmore than one proxy instance handles the traffic received by a backend\nservice. Thus, it is possible that an unhealthy endpoint is detected and\nejected by only some of the proxies, and while this happens, other proxies\nmay continue to send requests to the same unhealthy endpoint until they\ndetect and eject the unhealthy endpoint.\n\nApplicable backend endpoints can be:\n \n - VM instances in an Instance Group\n - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)\n - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)\n - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud\n Functions Services \n - Private Service Connect NEGs, that resolve to\n Google-managed regional API endpoints or managed services published using\n Private Service Connect\n\n\n\nApplicable backend service types can be:\n \n - A global backend service with the loadBalancingScheme set to\n INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. \n - A regional backend\n service with the serviceProtocol set to HTTP, HTTPS, HTTP2 or H2C, and\n loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not\n supported for Serverless NEGs.\n\n\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true." @@ -47707,6 +48090,17 @@ false }, "type": "object" }, +"BackendServiceOrchestrationInfo": { +"description": "A message containing information about the resource or system that manages\nthe backend service.", +"id": "BackendServiceOrchestrationInfo", +"properties": { +"resourceUri": { +"description": "The resource URI of the resource or system that manages the backend\nservice.", +"type": "string" +} +}, +"type": "object" +}, "BackendServiceParams": { "description": "Additional Backend Service parameters.", "id": "BackendServiceParams", @@ -50489,7 +50883,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" } }, @@ -51610,6 +52004,10 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"params": { +"$ref": "ExternalVpnGatewayParams", +"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload." +}, "redundancyType": { "description": "Indicates the user-supplied redundancy type of this external VPN gateway.", "enum": [ @@ -51812,6 +52210,19 @@ false }, "type": "object" }, +"ExternalVpnGatewayParams": { +"id": "ExternalVpnGatewayParams", +"properties": { +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.", +"type": "object" +} +}, +"type": "object" +}, "FileContentBuffer": { "id": "FileContentBuffer", "properties": { @@ -55378,155 +55789,18 @@ false }, "type": "object" }, -"HealthCheck": { -"description": "Represents a health check resource.\n\nGoogle Compute Engine has two health check resources:\n\n* [Regional](/compute/docs/reference/rest/v1/regionHealthChecks)\n* [Global](/compute/docs/reference/rest/v1/healthChecks)\n\nThese health check resources can be used for load balancing and for\nautohealing VMs in a managed instance group (MIG).\n\n**Load balancing**\n\nHealth check requirements vary depending on the type of load balancer. For\ndetails about the type of health check supported for\neach load balancer and corresponding backend type,\nsee Health\nchecks overview: Load balancer guide.\n\n**Autohealing in MIGs**\n\nThe health checks that you use for autohealing VMs in a MIG can be either\nregional or global. For more information, see Set up an\napplication health check and autohealing.\n\nFor more information, seeHealth checks\noverview.", -"id": "HealthCheck", +"HealthAggregationPoliciesScopedList": { +"id": "HealthAggregationPoliciesScopedList", "properties": { -"checkIntervalSec": { -"description": "How often (in seconds) to send a health check. The default value is 5\nseconds.", -"format": "int32", -"type": "integer" -}, -"creationTimestamp": { -"description": "Output only. [Output Only] Creation timestamp in3339\ntext format.", -"readOnly": true, -"type": "string" -}, -"description": { -"description": "An optional description of this resource. Provide this property when you\ncreate the resource.", -"type": "string" -}, -"grpcHealthCheck": { -"$ref": "GRPCHealthCheck" -}, -"grpcTlsHealthCheck": { -"$ref": "GRPCTLSHealthCheck" -}, -"healthyThreshold": { -"description": "A so-far unhealthy instance will be marked healthy after this\nmany consecutive successes. The default value is 2.", -"format": "int32", -"type": "integer" -}, -"http2HealthCheck": { -"$ref": "HTTP2HealthCheck" -}, -"httpHealthCheck": { -"$ref": "HTTPHealthCheck" -}, -"httpsHealthCheck": { -"$ref": "HTTPSHealthCheck" -}, -"id": { -"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", -"format": "uint64", -"type": "string" -}, -"kind": { -"default": "compute#healthCheck", -"description": "Output only. Type of the resource.", -"readOnly": true, -"type": "string" -}, -"logConfig": { -"$ref": "HealthCheckLogConfig", -"description": "Configure logging on this health check." -}, -"name": { -"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nFor example, a name that is 1-63 characters long, matches the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with\nRFC1035. This regular expression describes a name where the first\ncharacter is a lowercase letter, and all following characters are a dash,\nlowercase letter, or digit, except the last character, which isn't a dash.", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"type": "string" -}, -"region": { -"description": "Output only. [Output Only] Region where the health check resides. Not applicable to\nglobal health checks.", -"readOnly": true, -"type": "string" -}, -"selfLink": { -"description": "[Output Only] Server-defined URL for the resource.", -"type": "string" -}, -"sourceRegions": { -"description": "The list of cloud regions from which health checks are performed. If any\nregions are specified, then exactly 3 regions should be specified. The\nregion names must be valid names of Google Cloud regions.\nThis can only be set for global health check.\nIf this list is non-empty, then there are restrictions\non what other health check fields are supported and what other resources\ncan use this health check:\n \n - SSL, HTTP2, and GRPC protocols are not supported.\n - The TCP request field is not supported.\n - The proxyHeader field for HTTP, HTTPS, and TCP is not\n supported.\n - The checkIntervalSec field must be at least 30.\n - The health check cannot be used with BackendService nor with managed\n instance group auto-healing.", +"healthAggregationPolicies": { +"description": "A list of HealthAggregationPolicys contained in this scope.", "items": { -"type": "string" +"$ref": "HealthAggregationPolicy" }, "type": "array" }, -"sslHealthCheck": { -"$ref": "SSLHealthCheck" -}, -"tcpHealthCheck": { -"$ref": "TCPHealthCheck" -}, -"timeoutSec": { -"description": "How long (in seconds) to wait before claiming failure. The default value is\n5 seconds. It is invalid for timeoutSec to have greater\nvalue than checkIntervalSec.", -"format": "int32", -"type": "integer" -}, -"type": { -"description": "Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the\nprotocol-specific health check fields must be specified, which must matchtype field.", -"enum": [ -"GRPC", -"GRPC_WITH_TLS", -"HTTP", -"HTTP2", -"HTTPS", -"INVALID", -"SSL", -"TCP" -], -"enumDescriptions": [ -"", -"", -"", -"", -"", -"", -"", -"" -], -"type": "string" -}, -"unhealthyThreshold": { -"description": "A so-far healthy instance will be marked unhealthy after this many\nconsecutive failures. The default value is 2.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"HealthCheckList": { -"description": "Contains a list of HealthCheck resources.", -"id": "HealthCheckList", -"properties": { -"id": { -"description": "[Output Only] Unique identifier for the resource; defined by the server.", -"type": "string" -}, -"items": { -"description": "A list of HealthCheck resources.", -"items": { -"$ref": "HealthCheck" -}, -"type": "array" -}, -"kind": { -"default": "compute#healthCheckList", -"description": "Output only. Type of resource.", -"readOnly": true, -"type": "string" -}, -"nextPageToken": { -"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", -"type": "string" -}, -"selfLink": { -"description": "Output only. [Output Only] Server-defined URL for this resource.", -"readOnly": true, -"type": "string" -}, "warning": { -"description": "[Output Only] Informational warning message.", +"description": "Informational warning which replaces the list of health aggregation\npolicies when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", @@ -55652,30 +55926,9 @@ false }, "type": "object" }, -"HealthCheckLogConfig": { -"description": "Configuration of logging on a health check. If logging is enabled, logs\nwill be exported to Stackdriver.", -"id": "HealthCheckLogConfig", -"properties": { -"enable": { -"description": "Indicates whether or not to export logs. This is false by default, which\nmeans no health check logging will be done.", -"type": "boolean" -} -}, -"type": "object" -}, -"HealthCheckReference": { -"description": "A full or valid partial URL to a health check. For example, the following are\nvalid URLs:\n \n - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check\n - projects/project-id/global/httpHealthChecks/health-check\n - global/httpHealthChecks/health-check", -"id": "HealthCheckReference", -"properties": { -"healthCheck": { -"type": "string" -} -}, -"type": "object" -}, -"HealthCheckService": { -"description": "Represents a Health-Check as a Service resource.", -"id": "HealthCheckService", +"HealthAggregationPolicy": { +"description": "Represents a health aggregation policy.\n\nA health aggregation policy resource defines a policy to aggregate health.\n\nFor more information, see\nHealth checks overview.", +"id": "HealthAggregationPolicy", "properties": { "creationTimestamp": { "description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", @@ -55687,28 +55940,14 @@ false "type": "string" }, "fingerprint": { -"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthCheckService. An up-to-date fingerprint must\nbe provided in order to patch/update the HealthCheckService; Otherwise, the\nrequest will fail with error 412 conditionNotMet. To see the\nlatest fingerprint, make a get() request to retrieve the\nHealthCheckService.", +"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthAggregationPolicy. An up-to-date fingerprint\nmust be provided in order to patch the HealthAggregationPolicy; Otherwise,\nthe request will fail with error 412 conditionNotMet. To see\nthe latest fingerprint, make a get() request to retrieve the\nHealthAggregationPolicy.", "format": "byte", "type": "string" }, -"healthChecks": { -"description": "A list of URLs to the HealthCheck resources. Must have\nat least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For\nregional HealthCheckService, theHealthCheck must be regional and in the same\nregion. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the\nglobal HealthChecks must specify sourceRegions,\nand HealthChecks that specify sourceRegions can\nonly be used with global INTERNET_IP_PORTNetworkEndpointGroups.", -"items": { -"type": "string" -}, -"type": "array" -}, -"healthStatusAggregationPolicy": { -"description": "Optional. Policy for how the results from multiple health checks\nfor the same endpoint are aggregated. Defaults to NO_AGGREGATION\nif unspecified.\n \n - NO_AGGREGATION. An EndpointHealth message is\n returned for each pair in the health check\n service.\n - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.\n\n.\nThis is only allowed with regional HealthCheckService.", -"enum": [ -"AND", -"NO_AGGREGATION" -], -"enumDescriptions": [ -"If any backend's health check reports UNHEALTHY,\nthen UNHEALTHY is the HealthState of\nthe entire health check service. If all backend's are healthy,\nthe HealthState of the health check service isHEALTHY.", -"An EndpointHealth message is returned for each\nbackend in the health check service." -], -"type": "string" +"healthyPercentThreshold": { +"description": "Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a\npercentage) of healthy endpoints required in order to consider the\naggregated health result HEALTHY. Defaults to 60. Must be in\nrange [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,\nand will be set to the default if unspecified. Note that both this\nthreshold and minHealthyThreshold must be satisfied in order\nfor HEALTHY to be the aggregated result. \"Endpoints\" refers to network\nendpoints within a Network Endpoint Group or instances within an Instance\nGroup.", +"format": "uint32", +"type": "integer" }, "id": { "description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", @@ -55717,32 +55956,35 @@ false "type": "string" }, "kind": { -"default": "compute#healthCheckService", -"description": "Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.", +"default": "compute#healthAggregationPolicy", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation\npolicies.", "readOnly": true, "type": "string" }, +"minHealthyThreshold": { +"description": "Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of\nhealthy endpoints required in order to consider the aggregated health\nresult HEALTHY. Defaults to 1. Must be positive. Not\napplicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,\nand will be set to the default if unspecified. Note that both this\nthreshold and healthyPercentThreshold must be satisfied in\norder for HEALTHY to be the aggregated result. \"Endpoints\" refers to\nnetwork endpoints within a Network Endpoint Group or instances within an\nInstance Group.", +"format": "uint32", +"type": "integer" +}, "name": { -"description": "Name of the resource. The name must be 1-63 characters long, and comply\nwith RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character\nmust be a lowercase letter, and all following characters must be a dash,\nlowercase letter, or digit, except the last character, which cannot be a\ndash.", +"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, -"networkEndpointGroups": { -"description": "A list of URLs to the NetworkEndpointGroup\nresources. Must not have more than 100. For regionalHealthCheckService, NEGs must be in\nzones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups\nmust be global INTERNET_IP_PORT.", -"items": { -"type": "string" -}, -"type": "array" -}, -"notificationEndpoints": { -"description": "A list of URLs to the NotificationEndpoint\nresources. Must not have more than 10. A list of endpoints for\nreceiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the\nsame region. For global HealthCheckService,NotificationEndpoint must be global.", -"items": { +"policyType": { +"description": "Specifies the type of the healthAggregationPolicy. The only allowed value\nfor global resources is DNS_PUBLIC_IP_POLICY. The only allowed\nvalue for regional resources is BACKEND_SERVICE_POLICY. Must\nbe specified when the healthAggregationPolicy is created, and cannot be\nmutated.", +"enum": [ +"BACKEND_SERVICE_POLICY", +"DNS_PUBLIC_IP_POLICY" +], +"enumDescriptions": [ +"", +"" +], "type": "string" }, -"type": "array" -}, "region": { -"description": "Output only. [Output Only] URL of the region where the health check service\nresides. This field is not applicable to global health check services.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.", +"description": "Output only. [Output Only] URL of the region where the health aggregation policy\nresides. This field applies only to the regional resource. You must specify\nthis field as part of the HTTP request URL. It is not settable as a field\nin the request body.", "readOnly": true, "type": "string" }, @@ -55750,45 +55992,39 @@ false "description": "Output only. [Output Only] Server-defined URL for the resource.", "readOnly": true, "type": "string" -} -}, -"type": "object" }, -"HealthCheckServiceReference": { -"description": "A full or valid partial URL to a health check service. For example, the\nfollowing are valid URLs:\n \n - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service\n - projects/project-id/regions/us-west1/healthCheckServices/health-check-service\n - regions/us-west1/healthCheckServices/health-check-service", -"id": "HealthCheckServiceReference", -"properties": { -"healthCheckService": { +"selfLinkWithId": { +"description": "Output only. [Output Only] Server-defined URL with id for the resource.", +"readOnly": true, "type": "string" } }, "type": "object" }, -"HealthCheckServicesList": { -"id": "HealthCheckServicesList", +"HealthAggregationPolicyAggregatedList": { +"description": "Contains a list of HealthAggregationPoliciesScopedList.", +"id": "HealthAggregationPolicyAggregatedList", "properties": { "id": { -"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.", -"readOnly": true, +"description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"description": "Output only. A list of HealthCheckService resources.", -"items": { -"$ref": "HealthCheckService" +"additionalProperties": { +"$ref": "HealthAggregationPoliciesScopedList", +"description": "Name of the scope containing this set of HealthAggregationPolicies." }, -"readOnly": true, -"type": "array" +"description": "A list of HealthAggregationPoliciesScopedList resources.", +"type": "object" }, "kind": { -"default": "compute#healthCheckServicesList", -"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthCheckServicesList for lists of\nHealthCheckServices.", +"default": "compute#healthAggregationPolicyAggregatedList", +"description": "Output only. Type of resource.", "readOnly": true, "type": "string" }, "nextPageToken": { -"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", -"readOnly": true, +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", "type": "string" }, "selfLink": { @@ -55796,6 +56032,14 @@ false "readOnly": true, "type": "string" }, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -55923,24 +56167,23 @@ false }, "type": "object" }, -"HealthChecksAggregatedList": { -"id": "HealthChecksAggregatedList", +"HealthAggregationPolicyList": { +"id": "HealthAggregationPolicyList", "properties": { "id": { "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { -"additionalProperties": { -"$ref": "HealthChecksScopedList", -"description": "Name of the scope containing this set of HealthChecks." +"description": "A list of HealthAggregationPolicy resources.", +"items": { +"$ref": "HealthAggregationPolicy" }, -"description": "A list of HealthChecksScopedList resources.", -"type": "object" +"type": "array" }, "kind": { -"default": "compute#healthChecksAggregatedList", -"description": "Output only. Type of resource.", +"default": "compute#healthAggregationPolicyList", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation\npolicies.", "readOnly": true, "type": "string" }, @@ -55949,18 +56192,9 @@ false "type": "string" }, "selfLink": { -"description": "Output only. [Output Only] Server-defined URL for this resource.", -"readOnly": true, -"type": "string" -}, -"unreachables": { -"description": "Output only. [Output Only] Unreachable resources.", -"items": { +"description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, -"readOnly": true, -"type": "array" -}, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -56088,18 +56322,728 @@ false }, "type": "object" }, -"HealthChecksScopedList": { -"id": "HealthChecksScopedList", +"HealthCheck": { +"description": "Represents a health check resource.\n\nGoogle Compute Engine has two health check resources:\n\n* [Regional](/compute/docs/reference/rest/v1/regionHealthChecks)\n* [Global](/compute/docs/reference/rest/v1/healthChecks)\n\nThese health check resources can be used for load balancing and for\nautohealing VMs in a managed instance group (MIG).\n\n**Load balancing**\n\nHealth check requirements vary depending on the type of load balancer. For\ndetails about the type of health check supported for\neach load balancer and corresponding backend type,\nsee Health\nchecks overview: Load balancer guide.\n\n**Autohealing in MIGs**\n\nThe health checks that you use for autohealing VMs in a MIG can be either\nregional or global. For more information, see Set up an\napplication health check and autohealing.\n\nFor more information, seeHealth checks\noverview.", +"id": "HealthCheck", "properties": { -"healthChecks": { -"description": "A list of HealthChecks contained in this scope.", +"checkIntervalSec": { +"description": "How often (in seconds) to send a health check. The default value is 5\nseconds.", +"format": "int32", +"type": "integer" +}, +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp in3339\ntext format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "An optional description of this resource. Provide this property when you\ncreate the resource.", +"type": "string" +}, +"grpcHealthCheck": { +"$ref": "GRPCHealthCheck" +}, +"grpcTlsHealthCheck": { +"$ref": "GRPCTLSHealthCheck" +}, +"healthyThreshold": { +"description": "A so-far unhealthy instance will be marked healthy after this\nmany consecutive successes. The default value is 2.", +"format": "int32", +"type": "integer" +}, +"http2HealthCheck": { +"$ref": "HTTP2HealthCheck" +}, +"httpHealthCheck": { +"$ref": "HTTPHealthCheck" +}, +"httpsHealthCheck": { +"$ref": "HTTPSHealthCheck" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#healthCheck", +"description": "Output only. Type of the resource.", +"readOnly": true, +"type": "string" +}, +"logConfig": { +"$ref": "HealthCheckLogConfig", +"description": "Configure logging on this health check." +}, +"name": { +"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nFor example, a name that is 1-63 characters long, matches the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with\nRFC1035. This regular expression describes a name where the first\ncharacter is a lowercase letter, and all following characters are a dash,\nlowercase letter, or digit, except the last character, which isn't a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"region": { +"description": "Output only. [Output Only] Region where the health check resides. Not applicable to\nglobal health checks.", +"readOnly": true, +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"sourceRegions": { +"description": "The list of cloud regions from which health checks are performed. If any\nregions are specified, then exactly 3 regions should be specified. The\nregion names must be valid names of Google Cloud regions.\nThis can only be set for global health check.\nIf this list is non-empty, then there are restrictions\non what other health check fields are supported and what other resources\ncan use this health check:\n \n - SSL, HTTP2, and GRPC protocols are not supported.\n - The TCP request field is not supported.\n - The proxyHeader field for HTTP, HTTPS, and TCP is not\n supported.\n - The checkIntervalSec field must be at least 30.\n - The health check cannot be used with BackendService nor with managed\n instance group auto-healing.", +"items": { +"type": "string" +}, +"type": "array" +}, +"sslHealthCheck": { +"$ref": "SSLHealthCheck" +}, +"tcpHealthCheck": { +"$ref": "TCPHealthCheck" +}, +"timeoutSec": { +"description": "How long (in seconds) to wait before claiming failure. The default value is\n5 seconds. It is invalid for timeoutSec to have greater\nvalue than checkIntervalSec.", +"format": "int32", +"type": "integer" +}, +"type": { +"description": "Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the\nprotocol-specific health check fields must be specified, which must matchtype field.", +"enum": [ +"GRPC", +"GRPC_WITH_TLS", +"HTTP", +"HTTP2", +"HTTPS", +"INVALID", +"SSL", +"TCP" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +}, +"unhealthyThreshold": { +"description": "A so-far healthy instance will be marked unhealthy after this many\nconsecutive failures. The default value is 2.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"HealthCheckList": { +"description": "Contains a list of HealthCheck resources.", +"id": "HealthCheckList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of HealthCheck resources.", "items": { "$ref": "HealthCheck" }, "type": "array" }, +"kind": { +"default": "compute#healthCheckList", +"description": "Output only. Type of resource.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, "warning": { -"description": "Informational warning which replaces the list of\nbackend services when the list is empty.", +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthCheckLogConfig": { +"description": "Configuration of logging on a health check. If logging is enabled, logs\nwill be exported to Stackdriver.", +"id": "HealthCheckLogConfig", +"properties": { +"enable": { +"description": "Indicates whether or not to export logs. This is false by default, which\nmeans no health check logging will be done.", +"type": "boolean" +} +}, +"type": "object" +}, +"HealthCheckReference": { +"description": "A full or valid partial URL to a health check. For example, the following are\nvalid URLs:\n \n - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check\n - projects/project-id/global/httpHealthChecks/health-check\n - global/httpHealthChecks/health-check", +"id": "HealthCheckReference", +"properties": { +"healthCheck": { +"type": "string" +} +}, +"type": "object" +}, +"HealthCheckService": { +"description": "Represents a Health-Check as a Service resource.", +"id": "HealthCheckService", +"properties": { +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "An optional description of this resource. Provide this property when you\ncreate the resource.", +"type": "string" +}, +"fingerprint": { +"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthCheckService. An up-to-date fingerprint must\nbe provided in order to patch/update the HealthCheckService; Otherwise, the\nrequest will fail with error 412 conditionNotMet. To see the\nlatest fingerprint, make a get() request to retrieve the\nHealthCheckService.", +"format": "byte", +"type": "string" +}, +"healthChecks": { +"description": "A list of URLs to the HealthCheck resources. Must have\nat least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For\nregional HealthCheckService, theHealthCheck must be regional and in the same\nregion. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the\nglobal HealthChecks must specify sourceRegions,\nand HealthChecks that specify sourceRegions can\nonly be used with global INTERNET_IP_PORTNetworkEndpointGroups.", +"items": { +"type": "string" +}, +"type": "array" +}, +"healthStatusAggregationPolicy": { +"description": "Optional. Policy for how the results from multiple health checks\nfor the same endpoint are aggregated. Defaults to NO_AGGREGATION\nif unspecified.\n \n - NO_AGGREGATION. An EndpointHealth message is\n returned for each pair in the health check\n service.\n - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.\n\n.\nThis is only allowed with regional HealthCheckService.", +"enum": [ +"AND", +"NO_AGGREGATION" +], +"enumDescriptions": [ +"If any backend's health check reports UNHEALTHY,\nthen UNHEALTHY is the HealthState of\nthe entire health check service. If all backend's are healthy,\nthe HealthState of the health check service isHEALTHY.", +"An EndpointHealth message is returned for each\nbackend in the health check service." +], +"type": "string" +}, +"id": { +"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"kind": { +"default": "compute#healthCheckService", +"description": "Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Name of the resource. The name must be 1-63 characters long, and comply\nwith RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character\nmust be a lowercase letter, and all following characters must be a dash,\nlowercase letter, or digit, except the last character, which cannot be a\ndash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"networkEndpointGroups": { +"description": "A list of URLs to the NetworkEndpointGroup\nresources. Must not have more than 100. For regionalHealthCheckService, NEGs must be in\nzones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups\nmust be global INTERNET_IP_PORT.", +"items": { +"type": "string" +}, +"type": "array" +}, +"notificationEndpoints": { +"description": "A list of URLs to the NotificationEndpoint\nresources. Must not have more than 10. A list of endpoints for\nreceiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the\nsame region. For global HealthCheckService,NotificationEndpoint must be global.", +"items": { +"type": "string" +}, +"type": "array" +}, +"region": { +"description": "Output only. [Output Only] URL of the region where the health check service\nresides. This field is not applicable to global health check services.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.", +"readOnly": true, +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for the resource.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"HealthCheckServiceReference": { +"description": "A full or valid partial URL to a health check service. For example, the\nfollowing are valid URLs:\n \n - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service\n - projects/project-id/regions/us-west1/healthCheckServices/health-check-service\n - regions/us-west1/healthCheckServices/health-check-service", +"id": "HealthCheckServiceReference", +"properties": { +"healthCheckService": { +"type": "string" +} +}, +"type": "object" +}, +"HealthCheckServicesList": { +"id": "HealthCheckServicesList", +"properties": { +"id": { +"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.", +"readOnly": true, +"type": "string" +}, +"items": { +"description": "Output only. A list of HealthCheckService resources.", +"items": { +"$ref": "HealthCheckService" +}, +"readOnly": true, +"type": "array" +}, +"kind": { +"default": "compute#healthCheckServicesList", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthCheckServicesList for lists of\nHealthCheckServices.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"readOnly": true, +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthChecksAggregatedList": { +"id": "HealthChecksAggregatedList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"additionalProperties": { +"$ref": "HealthChecksScopedList", +"description": "Name of the scope containing this set of HealthChecks." +}, +"description": "A list of HealthChecksScopedList resources.", +"type": "object" +}, +"kind": { +"default": "compute#healthChecksAggregatedList", +"description": "Output only. Type of resource.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"HealthChecksScopedList": { +"id": "HealthChecksScopedList", +"properties": { +"healthChecks": { +"description": "A list of HealthChecks contained in this scope.", +"items": { +"$ref": "HealthCheck" +}, +"type": "array" +}, +"warning": { +"description": "Informational warning which replaces the list of\nbackend services when the list is empty.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", @@ -57635,7 +58579,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the image. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the image. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" } }, @@ -61236,7 +62180,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" } }, @@ -61346,7 +62290,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and\nvalues are in the format `tagValues/456`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and\nvalues are in the format `tagValues/456`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" }, "resourcePolicies": { @@ -67378,7 +68322,7 @@ false "additionalProperties": { "$ref": "LocationPolicyLocation" }, -"description": "Location configurations mapped by location name.\nCurrently only zone names are supported and must be represented as valid\ninternal URLs, such as zones/us-central1-a.", +"description": "Location configurations mapped by location name.\nCurrently only zone names are supported and must be represented as valid\ninternal URLs, such as zones/us-central1-a.\nThe bulkInsert operation doesn't create instances in an AI zone, even if\nan AI zone is available in the specified region. For example, if you set a\nDENY preference for us-central1-a, Compute Engine will consider\nus-central1-b and us-central1-c for instance creation, but not\nus-central1-ai1a. Also, you can't use the locations[] configuration to\nallow instance creation in an AI zone. To include an AI zone in bulkInsert\noperations, use the locationPolicy.zones[] field.", "type": "object" }, "targetShape": { @@ -67394,6 +68338,13 @@ false "GCE prioritizes acquisition of resources, scheduling VMs in zones\nwhere resources are available while distributing VMs as evenly as\npossible across allowed zones to minimize the impact of zonal failure.\nRecommended for highly available serving workloads." ], "type": "string" +}, +"zones": { +"description": "The bulkInsert operation applies any preferences set in the locations\nfield to the specific zones listed in the zones field if the same zones\nare specified in both fields.", +"items": { +"$ref": "LocationPolicyZoneConfiguration" +}, +"type": "array" } }, "type": "object" @@ -67434,6 +68385,16 @@ false }, "type": "object" }, +"LocationPolicyZoneConfiguration": { +"id": "LocationPolicyZoneConfiguration", +"properties": { +"zone": { +"description": "The URL of the zone.\nThe zone must exist in the region where the request is called.\nZones must be represented as valid partial URLs,\nsuch as zones/us-central1-a.", +"type": "string" +} +}, +"type": "object" +}, "MachineImage": { "description": "Represents a machine image resource.\n\nA machine image is a Compute Engine resource that stores all the\nconfiguration, metadata, permissions, and data from one or more disks\nrequired to create a Virtual machine (VM) instance. For more information, seeMachine images.", "id": "MachineImage", @@ -80457,6 +81418,10 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"params": { +"$ref": "ReservationParams", +"description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload." +}, "protectionTier": { "description": "Protection tier for the workload which specifies the workload expectations\nin the event of infrastructure failures at data center (e.g. power\nand/or cooling failures).", "enum": [ @@ -81286,6 +82251,20 @@ false }, "type": "object" }, +"ReservationParams": { +"description": "Additional reservation params.", +"id": "ReservationParams", +"properties": { +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Input only. Resource manager tags to be bound to the reservation. Tag keys and\nvalues have the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"type": "object" +} +}, +"type": "object" +}, "ReservationSlot": { "description": "Represents a reservation slot resource.", "id": "ReservationSlot", @@ -81338,13 +82317,15 @@ false "ACTIVE", "CREATING", "DELETING", -"STATE_UNSPECIFIED" +"STATE_UNSPECIFIED", +"UNAVAILABLE" ], "enumDescriptions": [ "The reservation slot has allocated all its resources.", "The resources are being allocated for the reservation slot.", "The reservation slot is currently being deleted.", -"" +"", +"The reservation slot is currently unavailable." ], "readOnly": true, "type": "string" @@ -83153,6 +84134,10 @@ false "description": "Effective enable-oslogin value at Instance level.", "type": "boolean" }, +"gceContainerDeclarationMetadataValue": { +"description": "Effective gce-container-declaration value at Instance level.", +"type": "boolean" +}, "serialPortEnableMetadataValue": { "description": "Effective serial-port-enable value at Instance level.", "type": "boolean" @@ -88791,7 +89776,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Resource manager tags to be bound to the snapshot. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", +"description": "Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/456` or in namespaced\nformat such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.", "type": "object" } }, @@ -96302,6 +97287,10 @@ false "description": "URL of the network to which this VPN gateway is attached. Provided by the\nclient when the VPN gateway is created.", "type": "string" }, +"params": { +"$ref": "TargetVpnGatewayParams", +"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload." +}, "region": { "description": "[Output Only] URL of the region where the target VPN gateway resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.", "type": "string" @@ -96658,6 +97647,19 @@ false }, "type": "object" }, +"TargetVpnGatewayParams": { +"id": "TargetVpnGatewayParams", +"properties": { +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.", +"type": "object" +} +}, +"type": "object" +}, "TargetVpnGatewaysScopedList": { "id": "TargetVpnGatewaysScopedList", "properties": { @@ -98311,6 +99313,10 @@ false "description": "URL of the network to which this VPN gateway is attached. Provided by the\nclient when the VPN gateway is created.", "type": "string" }, +"params": { +"$ref": "VpnGatewayParams", +"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload." +}, "region": { "description": "Output only. [Output Only] URL of the region where the VPN gateway resides.", "readOnly": true, @@ -98667,6 +99673,19 @@ false }, "type": "object" }, +"VpnGatewayParams": { +"id": "VpnGatewayParams", +"properties": { +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.", +"type": "object" +} +}, +"type": "object" +}, "VpnGatewayStatus": { "id": "VpnGatewayStatus", "properties": { @@ -99001,6 +100020,10 @@ false "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, +"params": { +"$ref": "VpnTunnelParams", +"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload." +}, "peerExternalGateway": { "description": "URL of the peer side external VPN gateway to which this VPN tunnel is\nconnected.\nProvided by the client when the VPN tunnel is created.\nThis field is exclusive with the field peerGcpGateway.", "type": "string" @@ -99429,6 +100452,19 @@ false }, "type": "object" }, +"VpnTunnelParams": { +"id": "VpnTunnelParams", +"properties": { +"resourceManagerTags": { +"additionalProperties": { +"type": "string" +}, +"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.", +"type": "object" +} +}, +"type": "object" +}, "VpnTunnelPhase1Algorithms": { "id": "VpnTunnelPhase1Algorithms", "properties": { From 5561147a9b6fb406b8fadd604b4c8628a181c694 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 24 Feb 2026 07:27:56 +0000 Subject: [PATCH 06/29] feat(containeranalysis): update the api #### containeranalysis:v1 The following keys were added: - schemas.BaseImage.properties.registry.type (Total Keys: 1) #### containeranalysis:v1alpha1 The following keys were added: - schemas.BaseImage.properties.registry.type (Total Keys: 1) --- ....projects.locations.notes.occurrences.html | 2 ++ ...sis_v1.projects.locations.occurrences.html | 16 ++++++++++++++++ ...nalysis_v1.projects.notes.occurrences.html | 2 ++ ...aineranalysis_v1.projects.occurrences.html | 16 ++++++++++++++++ ...aineranalysis_v1alpha1.projects.notes.html | 6 ++++++ ...s_v1alpha1.projects.notes.occurrences.html | 3 +++ ...nalysis_v1alpha1.projects.occurrences.html | 19 +++++++++++++++++++ ...ineranalysis_v1alpha1.providers.notes.html | 6 ++++++ ..._v1alpha1.providers.notes.occurrences.html | 3 +++ .../documents/containeranalysis.v1.json | 6 +++++- .../documents/containeranalysis.v1alpha1.json | 6 +++++- 11 files changed, 83 insertions(+), 2 deletions(-) diff --git a/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html b/docs/dyn/containeranalysis_v1.projects.locations.notes.occurrences.html index a1ab20e9d2c..37270b074fc 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 8b2c5082473..bfdbea0a264 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 c2ffedee097..f092b187755 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 07df20237fd..5dcd5e3673f 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 785641febfa..0ff12c6c699 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 8398d953bfa..0a3eb5c4b43 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 ad0b2f1b6e9..0b594f7d613 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 4e8c2037715..4ae9d778029 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 9496b4605fa..2c6453d81bf 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/googleapiclient/discovery_cache/documents/containeranalysis.v1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json index 92596c1cdd8..aa3ebc22f4d 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json @@ -1715,7 +1715,7 @@ } } }, -"revision": "20260130", +"revision": "20260213", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -1897,6 +1897,10 @@ "description": "The name of the base image.", "type": "string" }, +"registry": { +"description": "The registry in which the base image is from.", +"type": "string" +}, "repository": { "description": "The repository name in which the base image is from.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json index 6565ea23a2f..bb259fefe03 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json @@ -1452,7 +1452,7 @@ } } }, -"revision": "20260123", +"revision": "20260213", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -1606,6 +1606,10 @@ "description": "The name of the base image.", "type": "string" }, +"registry": { +"description": "The registry of the base image.", +"type": "string" +}, "repository": { "description": "The repository name in which the base image is from.", "type": "string" From 0b06fceeb8a89c11b6c688b3978c6235c019e6de Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 24 Feb 2026 07:27:56 +0000 Subject: [PATCH 07/29] feat(dataflow): update the api #### dataflow:v1b3 The following keys were added: - schemas.WorkerPool.properties.diskProvisionedIops (Total Keys: 2) - schemas.WorkerPool.properties.diskProvisionedThroughputMibps (Total Keys: 2) The following keys were changed: - endpoints (Total Keys: 1) --- docs/dyn/dataflow_v1b3.projects.jobs.html | 14 ++++++++++++++ ...w_v1b3.projects.locations.flexTemplates.html | 2 ++ .../dataflow_v1b3.projects.locations.jobs.html | 12 ++++++++++++ ...aflow_v1b3.projects.locations.templates.html | 4 ++++ docs/dyn/dataflow_v1b3.projects.templates.html | 4 ++++ .../documents/dataflow.v1b3.json | 17 ++++++++++++++++- 6 files changed, 52 insertions(+), 1 deletion(-) diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html index 53c9a795a62..a821a883fc8 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 9aaa6278624..3ae321c66cf 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 0a28f0f2074..015e43de624 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 78160f9b1e3..ff21ad63f05 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 0d077f9482a..e921a1cfeea 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/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index ebcd40edb46..cc7ef452e1a 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -96,6 +96,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://dataflow.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dataflow.europe-southwest1.rep.googleapis.com/", "location": "europe-southwest1" }, @@ -2395,7 +2400,7 @@ } } }, -"revision": "20260208", +"revision": "20260213", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -8189,6 +8194,16 @@ false ], "type": "string" }, +"diskProvisionedIops": { +"description": "Optional. IOPS provisioned for the root disk for VMs.", +"format": "int64", +"type": "string" +}, +"diskProvisionedThroughputMibps": { +"description": "Optional. Throughput provisioned for the root disk for VMs.", +"format": "int64", +"type": "string" +}, "diskSizeGb": { "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.", "format": "int32", From 457385fe619a3ff6ec6c819a54fa31d1357b6e11 Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 24 Feb 2026 07:27:56 +0000 Subject: [PATCH 08/29] feat(datamanager): update the api #### datamanager:v1 The following keys were added: - resources.accountTypes.resources.accounts.resources.insights.methods.retrieve (Total Keys: 12) - resources.accountTypes.resources.accounts.resources.partnerLinks.methods.create (Total Keys: 12) - resources.accountTypes.resources.accounts.resources.partnerLinks.methods.delete (Total Keys: 11) - resources.accountTypes.resources.accounts.resources.partnerLinks.methods.search (Total Keys: 18) - resources.accountTypes.resources.accounts.resources.userListDirectLicenses.methods.create (Total Keys: 12) - resources.accountTypes.resources.accounts.resources.userListDirectLicenses.methods.get (Total Keys: 11) - resources.accountTypes.resources.accounts.resources.userListDirectLicenses.methods.list (Total Keys: 18) - resources.accountTypes.resources.accounts.resources.userListDirectLicenses.methods.patch (Total Keys: 15) - resources.accountTypes.resources.accounts.resources.userListGlobalLicenses.methods.create (Total Keys: 12) - resources.accountTypes.resources.accounts.resources.userListGlobalLicenses.methods.get (Total Keys: 11) - resources.accountTypes.resources.accounts.resources.userListGlobalLicenses.methods.list (Total Keys: 18) - resources.accountTypes.resources.accounts.resources.userListGlobalLicenses.methods.patch (Total Keys: 15) - resources.accountTypes.resources.accounts.resources.userListGlobalLicenses.resources.userListGlobalLicenseCustomerInfos.methods.list (Total Keys: 18) - resources.accountTypes.resources.accounts.resources.userLists.methods.create (Total Keys: 14) - resources.accountTypes.resources.accounts.resources.userLists.methods.delete (Total Keys: 13) - resources.accountTypes.resources.accounts.resources.userLists.methods.get (Total Keys: 11) - resources.accountTypes.resources.accounts.resources.userLists.methods.list (Total Keys: 18) - resources.accountTypes.resources.accounts.resources.userLists.methods.patch (Total Keys: 17) - schemas.AudienceMember.properties.ppidData.$ref (Total Keys: 1) - schemas.AudienceMember.properties.userIdData.$ref (Total Keys: 1) - schemas.Baseline (Total Keys: 4) - schemas.ContactIdInfo (Total Keys: 6) - schemas.Empty (Total Keys: 2) - schemas.IngestAudienceMembersStatus.properties.ppidDataIngestionStatus.$ref (Total Keys: 1) - schemas.IngestAudienceMembersStatus.properties.userIdDataIngestionStatus.$ref (Total Keys: 1) - schemas.IngestPpidDataStatus (Total Keys: 6) - schemas.IngestUserIdDataStatus (Total Keys: 6) - schemas.IngestedUserListInfo (Total Keys: 10) - schemas.ListUserListDirectLicensesResponse (Total Keys: 5) - schemas.ListUserListGlobalLicenseCustomerInfosResponse (Total Keys: 5) - schemas.ListUserListGlobalLicensesResponse (Total Keys: 5) - schemas.ListUserListsResponse (Total Keys: 5) - schemas.Location (Total Keys: 4) - schemas.MarketingDataInsight (Total Keys: 13) - schemas.MobileIdInfo (Total Keys: 5) - schemas.PairIdInfo (Total Keys: 12) - schemas.PartnerAudienceInfo (Total Keys: 4) - schemas.PartnerLink (Total Keys: 7) - schemas.PpidData (Total Keys: 4) - schemas.PseudonymousIdInfo (Total Keys: 6) - schemas.RemoveAudienceMembersStatus.properties.ppidDataRemovalStatus.$ref (Total Keys: 1) - schemas.RemoveAudienceMembersStatus.properties.userIdDataRemovalStatus.$ref (Total Keys: 1) - schemas.RemovePpidDataStatus (Total Keys: 6) - schemas.RemoveUserIdDataStatus (Total Keys: 6) - schemas.RetrieveInsightsRequest (Total Keys: 4) - schemas.RetrieveInsightsResponse (Total Keys: 4) - schemas.SearchPartnerLinksResponse (Total Keys: 5) - schemas.SizeInfo (Total Keys: 8) - schemas.TargetNetworkInfo (Total Keys: 5) - schemas.UserIdData (Total Keys: 3) - schemas.UserIdInfo (Total Keys: 3) - schemas.UserList (Total Keys: 119) --- .../datamanager_v1.accountTypes.accounts.html | 111 + ...ger_v1.accountTypes.accounts.insights.html | 135 + ...v1.accountTypes.accounts.partnerLinks.html | 216 ++ ...Types.accounts.userListDirectLicenses.html | 436 +++ ...Types.accounts.userListGlobalLicenses.html | 429 +++ ...es.userListGlobalLicenseCustomerInfos.html | 171 + ...er_v1.accountTypes.accounts.userLists.html | 538 +++ docs/dyn/datamanager_v1.accountTypes.html | 91 + docs/dyn/datamanager_v1.audienceMembers.html | 20 +- docs/dyn/datamanager_v1.html | 5 + docs/dyn/datamanager_v1.requestStatus.html | 16 + .../documents/datamanager.v1.json | 3294 +++++++++++++---- 12 files changed, 4694 insertions(+), 768 deletions(-) create mode 100644 docs/dyn/datamanager_v1.accountTypes.accounts.html create mode 100644 docs/dyn/datamanager_v1.accountTypes.accounts.insights.html create mode 100644 docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html create mode 100644 docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html create mode 100644 docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html create mode 100644 docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html create mode 100644 docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html create mode 100644 docs/dyn/datamanager_v1.accountTypes.html diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.html b/docs/dyn/datamanager_v1.accountTypes.accounts.html new file mode 100644 index 00000000000..7064b848b98 --- /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 00000000000..0009595ceff --- /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 00000000000..0fda4012bd4 --- /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 00000000000..08cd5168d13 --- /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 00000000000..9dfc3583773 --- /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 00000000000..7c4e873ff50 --- /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 00000000000..6cf0a8f4d66 --- /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 00000000000..83957180a0b --- /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 342d814fa96..bf38e52c4cb 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 f757499f8e9..591cc2fa1a2 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 cc2111b0d09..3c9fd359d94 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/googleapiclient/discovery_cache/documents/datamanager.v1.json b/googleapiclient/discovery_cache/documents/datamanager.v1.json index aa3c1588c20..e3d315bffff 100644 --- a/googleapiclient/discovery_cache/documents/datamanager.v1.json +++ b/googleapiclient/discovery_cache/documents/datamanager.v1.json @@ -105,642 +105,2120 @@ }, "protocol": "rest", "resources": { -"audienceMembers": { +"accountTypes": { +"resources": { +"accounts": { +"resources": { +"insights": { "methods": { -"ingest": { -"description": "Uploads a list of AudienceMember resources to the provided Destination.", -"flatPath": "v1/audienceMembers:ingest", +"retrieve": { +"description": "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}`", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/insights:retrieve", "httpMethod": "POST", -"id": "datamanager.audienceMembers.ingest", -"parameterOrder": [], -"parameters": {}, -"path": "v1/audienceMembers:ingest", +"id": "datamanager.accountTypes.accounts.insights.retrieve", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent account that owns the user list. Format: `accountTypes/{account_type}/accounts/{account}`", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/insights:retrieve", "request": { -"$ref": "IngestAudienceMembersRequest" +"$ref": "RetrieveInsightsRequest" }, "response": { -"$ref": "IngestAudienceMembersResponse" +"$ref": "RetrieveInsightsResponse" }, "scopes": [ "https://www.googleapis.com/auth/datamanager" ] +} +} }, -"remove": { -"description": "Removes a list of AudienceMember resources from the provided Destination.", -"flatPath": "v1/audienceMembers:remove", +"partnerLinks": { +"methods": { +"create": { +"description": "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}`", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/partnerLinks", "httpMethod": "POST", -"id": "datamanager.audienceMembers.remove", -"parameterOrder": [], -"parameters": {}, -"path": "v1/audienceMembers:remove", +"id": "datamanager.accountTypes.accounts.partnerLinks.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent, which owns this collection of partner links. Format: accountTypes/{account_type}/accounts/{account}", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/partnerLinks", "request": { -"$ref": "RemoveAudienceMembersRequest" +"$ref": "PartnerLink" }, "response": { -"$ref": "RemoveAudienceMembersResponse" +"$ref": "PartnerLink" }, "scopes": [ "https://www.googleapis.com/auth/datamanager" ] -} -} }, -"events": { -"methods": { -"ingest": { -"description": "Uploads a list of Event resources from the provided Destination.", -"flatPath": "v1/events:ingest", -"httpMethod": "POST", -"id": "datamanager.events.ingest", -"parameterOrder": [], -"parameters": {}, -"path": "v1/events:ingest", -"request": { -"$ref": "IngestEventsRequest" +"delete": { +"description": "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}`", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/partnerLinks/{partnerLinksId}", +"httpMethod": "DELETE", +"id": "datamanager.accountTypes.accounts.partnerLinks.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the partner link to delete. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+/partnerLinks/[^/]+$", +"required": true, +"type": "string" +} }, +"path": "v1/{+name}", "response": { -"$ref": "IngestEventsResponse" +"$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/datamanager" ] -} -} }, -"requestStatus": { -"methods": { -"retrieve": { -"description": "Gets the status of a request given request id.", -"flatPath": "v1/requestStatus:retrieve", +"search": { +"description": "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}`", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/partnerLinks:search", "httpMethod": "GET", -"id": "datamanager.requestStatus.retrieve", -"parameterOrder": [], +"id": "datamanager.accountTypes.accounts.partnerLinks.search", +"parameterOrder": [ +"parent" +], "parameters": { -"requestId": { -"description": "Required. Required. The request ID of the Data Manager API request.", +"filter": { +"description": "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`", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "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.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "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.", "location": "query", "type": "string" +}, +"parent": { +"description": "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}`", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1/requestStatus:retrieve", +"path": "v1/{+parent}/partnerLinks:search", "response": { -"$ref": "RetrieveRequestStatusResponse" +"$ref": "SearchPartnerLinksResponse" }, "scopes": [ "https://www.googleapis.com/auth/datamanager" ] } } -} }, -"revision": "20260102", -"rootUrl": "https://datamanager.googleapis.com/", -"schemas": { -"AdIdentifiers": { -"description": "Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).", -"id": "AdIdentifiers", -"properties": { -"gbraid": { -"description": "Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.", +"userListDirectLicenses": { +"methods": { +"create": { +"description": "Creates a user list direct license. This feature is only available to data partners.", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses", +"httpMethod": "POST", +"id": "datamanager.accountTypes.accounts.userListDirectLicenses.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+$", +"required": true, "type": "string" +} }, -"gclid": { -"description": "Optional. The Google click ID (gclid) associated with this event.", -"type": "string" +"path": "v1/{+parent}/userListDirectLicenses", +"request": { +"$ref": "UserListDirectLicense" }, -"landingPageDeviceInfo": { -"$ref": "DeviceInfo", -"description": "Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser\u2019s site after interacting with the ad." +"response": { +"$ref": "UserListDirectLicense" }, -"sessionAttributes": { -"description": "Optional. Session attributes for event attribution and modeling.", -"type": "string" +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] }, -"wbraid": { -"description": "Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14.", +"get": { +"description": "Retrieves a user list direct license. This feature is only available to data partners.", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses/{userListDirectLicensesId}", +"httpMethod": "GET", +"id": "datamanager.accountTypes.accounts.userListDirectLicenses.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the user list direct license.", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListDirectLicenses/[^/]+$", +"required": true, "type": "string" } }, -"type": "object" +"path": "v1/{+name}", +"response": { +"$ref": "UserListDirectLicense" }, -"AddressInfo": { -"description": "Address information for the user.", -"id": "AddressInfo", -"properties": { -"familyName": { -"description": "Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.", -"type": "string" +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] }, -"givenName": { -"description": "Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.", +"list": { +"description": "Lists all user list direct licenses owned by the parent account. This feature is only available to data partners.", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses", +"httpMethod": "GET", +"id": "datamanager.accountTypes.accounts.userListDirectLicenses.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "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`", +"location": "query", "type": "string" }, -"postalCode": { -"description": "Required. The postal code of the user's address.", +"pageSize": { +"description": "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.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "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.", +"location": "query", "type": "string" }, -"regionCode": { -"description": "Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.", +"parent": { +"description": "Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+$", +"required": true, "type": "string" } }, -"type": "object" +"path": "v1/{+parent}/userListDirectLicenses", +"response": { +"$ref": "ListUserListDirectLicensesResponse" }, -"AudienceMember": { -"description": "The audience member to be operated on.", -"id": "AudienceMember", -"properties": { -"consent": { -"$ref": "Consent", -"description": "Optional. The consent setting for the user." +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] }, -"destinationReferences": { -"description": "Optional. Defines which Destination to send the audience member to.", -"items": { +"patch": { +"description": "Updates a user list direct license. This feature is only available to data partners.", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListDirectLicenses/{userListDirectLicensesId}", +"httpMethod": "PATCH", +"id": "datamanager.accountTypes.accounts.userListDirectLicenses.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the user list direct license.", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListDirectLicenses/[^/]+$", +"required": true, "type": "string" }, -"type": "array" +"updateMask": { +"description": "Optional. The list of fields to update. The special character `*` is not supported and an `INVALID_UPDATE_MASK` error will be thrown if used.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} }, -"mobileData": { -"$ref": "MobileData", -"description": "Data identifying the user's mobile devices." +"path": "v1/{+name}", +"request": { +"$ref": "UserListDirectLicense" }, -"pairData": { -"$ref": "PairData", -"description": "[Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908)." +"response": { +"$ref": "UserListDirectLicense" }, -"userData": { -"$ref": "UserData", -"description": "User-provided data that identifies the user." +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +} } }, -"type": "object" -}, -"AwsWrappedKeyInfo": { -"description": "A data encryption key wrapped by an AWS KMS key.", -"id": "AwsWrappedKeyInfo", -"properties": { -"encryptedDek": { -"description": "Required. The base64 encoded encrypted data encryption key.", +"userListGlobalLicenses": { +"methods": { +"create": { +"description": "Creates a user list global license. This feature is only available to data partners.", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses", +"httpMethod": "POST", +"id": "datamanager.accountTypes.accounts.userListGlobalLicenses.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+$", +"required": true, "type": "string" +} }, -"kekUri": { -"description": "Required. The URI of the AWS KMS key used to decrypt the DEK. Should be in the format of `arn:{partition}:kms:{region}:{account_id}:key/{key_id}` or `aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}`", -"type": "string" +"path": "v1/{+parent}/userListGlobalLicenses", +"request": { +"$ref": "UserListGlobalLicense" }, -"keyType": { -"description": "Required. The type of algorithm used to encrypt the data.", -"enum": [ -"KEY_TYPE_UNSPECIFIED", -"XCHACHA20_POLY1305" -], -"enumDescriptions": [ -"Unspecified key type. Should never be used.", -"Algorithm XChaCha20-Poly1305" -], -"type": "string" +"response": { +"$ref": "UserListGlobalLicense" }, -"roleArn": { -"description": "Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of `arn:{partition}:iam::{account_id}:role/{role_name}`", +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +}, +"get": { +"description": "Retrieves a user list global license. This feature is only available to data partners.", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses/{userListGlobalLicensesId}", +"httpMethod": "GET", +"id": "datamanager.accountTypes.accounts.userListGlobalLicenses.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the user list global license.", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$", +"required": true, "type": "string" } }, -"type": "object" +"path": "v1/{+name}", +"response": { +"$ref": "UserListGlobalLicense" }, -"CartData": { -"description": "The cart data associated with the event.", -"id": "CartData", -"properties": { -"items": { -"description": "Optional. The list of items associated with the event.", -"items": { -"$ref": "Item" +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] }, -"type": "array" +"list": { +"description": "Lists all user list global licenses owned by the parent account. This feature is only available to data partners.", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses", +"httpMethod": "GET", +"id": "datamanager.accountTypes.accounts.userListGlobalLicenses.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "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`", +"location": "query", +"type": "string" }, -"merchantFeedLabel": { -"description": "Optional. The Merchant Center feed label associated with the feed of the items.", +"pageSize": { +"description": "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.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "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.", +"location": "query", "type": "string" }, -"merchantFeedLanguageCode": { -"description": "Optional. The language code in ISO 639-1 associated with the Merchant Center feed of the items.where your items are uploaded.", +"parent": { +"description": "Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+$", +"required": true, "type": "string" +} }, -"merchantId": { -"description": "Optional. The Merchant Center ID associated with the items.", +"path": "v1/{+parent}/userListGlobalLicenses", +"response": { +"$ref": "ListUserListGlobalLicensesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +}, +"patch": { +"description": "Updates a user list global license. This feature is only available to data partners.", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses/{userListGlobalLicensesId}", +"httpMethod": "PATCH", +"id": "datamanager.accountTypes.accounts.userListGlobalLicenses.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the user list global license.", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$", +"required": true, "type": "string" }, -"transactionDiscount": { -"description": "Optional. The sum of all discounts associated with the transaction.", -"format": "double", -"type": "number" +"updateMask": { +"description": "Optional. The list of fields to update. The special character `*` is not supported and an `INVALID_UPDATE_MASK` error will be thrown if used.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, -"type": "object" +"path": "v1/{+name}", +"request": { +"$ref": "UserListGlobalLicense" +}, +"response": { +"$ref": "UserListGlobalLicense" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +} +}, +"resources": { +"userListGlobalLicenseCustomerInfos": { +"methods": { +"list": { +"description": "Lists all customer info for a user list global license. This feature is only available to data partners.", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userListGlobalLicenses/{userListGlobalLicensesId}/userListGlobalLicenseCustomerInfos", +"httpMethod": "GET", +"id": "datamanager.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "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`", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "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.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "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.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "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/-`)", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userListGlobalLicenses/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/userListGlobalLicenseCustomerInfos", +"response": { +"$ref": "ListUserListGlobalLicenseCustomerInfosResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +} +} +} +} +}, +"userLists": { +"methods": { +"create": { +"description": "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}`", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists", +"httpMethod": "POST", +"id": "datamanager.accountTypes.accounts.userLists.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent account where this user list will be created. Format: accountTypes/{account_type}/accounts/{account}", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +}, +"validateOnly": { +"description": "Optional. If true, the request is validated but not executed.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+parent}/userLists", +"request": { +"$ref": "UserList" +}, +"response": { +"$ref": "UserList" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +}, +"delete": { +"description": "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}`", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists/{userListsId}", +"httpMethod": "DELETE", +"id": "datamanager.accountTypes.accounts.userLists.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the user list to delete. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$", +"required": true, +"type": "string" +}, +"validateOnly": { +"description": "Optional. If true, the request is validated but not executed.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +}, +"get": { +"description": "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}`", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists/{userListsId}", +"httpMethod": "GET", +"id": "datamanager.accountTypes.accounts.userLists.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the UserList to retrieve. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "UserList" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +}, +"list": { +"description": "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}`", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists", +"httpMethod": "GET", +"id": "datamanager.accountTypes.accounts.userLists.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "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`", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "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.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "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.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/userLists", +"response": { +"$ref": "ListUserListsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +}, +"patch": { +"description": "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}`", +"flatPath": "v1/accountTypes/{accountTypesId}/accounts/{accountsId}/userLists/{userListsId}", +"httpMethod": "PATCH", +"id": "datamanager.accountTypes.accounts.userLists.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}", +"location": "path", +"pattern": "^accountTypes/[^/]+/accounts/[^/]+/userLists/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If true, the request is validated but not executed.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "UserList" +}, +"response": { +"$ref": "UserList" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +} +} +} +} +} +} +}, +"audienceMembers": { +"methods": { +"ingest": { +"description": "Uploads a list of AudienceMember resources to the provided Destination.", +"flatPath": "v1/audienceMembers:ingest", +"httpMethod": "POST", +"id": "datamanager.audienceMembers.ingest", +"parameterOrder": [], +"parameters": {}, +"path": "v1/audienceMembers:ingest", +"request": { +"$ref": "IngestAudienceMembersRequest" +}, +"response": { +"$ref": "IngestAudienceMembersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +}, +"remove": { +"description": "Removes a list of AudienceMember resources from the provided Destination.", +"flatPath": "v1/audienceMembers:remove", +"httpMethod": "POST", +"id": "datamanager.audienceMembers.remove", +"parameterOrder": [], +"parameters": {}, +"path": "v1/audienceMembers:remove", +"request": { +"$ref": "RemoveAudienceMembersRequest" +}, +"response": { +"$ref": "RemoveAudienceMembersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +} +} +}, +"events": { +"methods": { +"ingest": { +"description": "Uploads a list of Event resources from the provided Destination.", +"flatPath": "v1/events:ingest", +"httpMethod": "POST", +"id": "datamanager.events.ingest", +"parameterOrder": [], +"parameters": {}, +"path": "v1/events:ingest", +"request": { +"$ref": "IngestEventsRequest" +}, +"response": { +"$ref": "IngestEventsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +} +} +}, +"requestStatus": { +"methods": { +"retrieve": { +"description": "Gets the status of a request given request id.", +"flatPath": "v1/requestStatus:retrieve", +"httpMethod": "GET", +"id": "datamanager.requestStatus.retrieve", +"parameterOrder": [], +"parameters": { +"requestId": { +"description": "Required. Required. The request ID of the Data Manager API request.", +"location": "query", +"type": "string" +} +}, +"path": "v1/requestStatus:retrieve", +"response": { +"$ref": "RetrieveRequestStatusResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/datamanager" +] +} +} +} +}, +"revision": "20260217", +"rootUrl": "https://datamanager.googleapis.com/", +"schemas": { +"AdIdentifiers": { +"description": "Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).", +"id": "AdIdentifiers", +"properties": { +"gbraid": { +"description": "Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.", +"type": "string" +}, +"gclid": { +"description": "Optional. The Google click ID (gclid) associated with this event.", +"type": "string" +}, +"landingPageDeviceInfo": { +"$ref": "DeviceInfo", +"description": "Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser\u2019s site after interacting with the ad." +}, +"sessionAttributes": { +"description": "Optional. Session attributes for event attribution and modeling.", +"type": "string" +}, +"wbraid": { +"description": "Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14.", +"type": "string" +} +}, +"type": "object" +}, +"AddressInfo": { +"description": "Address information for the user.", +"id": "AddressInfo", +"properties": { +"familyName": { +"description": "Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.", +"type": "string" +}, +"givenName": { +"description": "Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.", +"type": "string" +}, +"postalCode": { +"description": "Required. The postal code of the user's address.", +"type": "string" +}, +"regionCode": { +"description": "Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.", +"type": "string" +} +}, +"type": "object" +}, +"AudienceMember": { +"description": "The audience member to be operated on.", +"id": "AudienceMember", +"properties": { +"consent": { +"$ref": "Consent", +"description": "Optional. The consent setting for the user." +}, +"destinationReferences": { +"description": "Optional. Defines which Destination to send the audience member to.", +"items": { +"type": "string" +}, +"type": "array" +}, +"mobileData": { +"$ref": "MobileData", +"description": "Data identifying the user's mobile devices." +}, +"pairData": { +"$ref": "PairData", +"description": "[Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908). This feature is only available to data partners." +}, +"ppidData": { +"$ref": "PpidData", +"description": "Data related to publisher provided identifiers. This feature is only available to data partners." +}, +"userData": { +"$ref": "UserData", +"description": "User-provided data that identifies the user." +}, +"userIdData": { +"$ref": "UserIdData", +"description": "Data related to unique identifiers for a user, as defined by the advertiser." +} +}, +"type": "object" +}, +"AwsWrappedKeyInfo": { +"description": "A data encryption key wrapped by an AWS KMS key.", +"id": "AwsWrappedKeyInfo", +"properties": { +"encryptedDek": { +"description": "Required. The base64 encoded encrypted data encryption key.", +"type": "string" +}, +"kekUri": { +"description": "Required. The URI of the AWS KMS key used to decrypt the DEK. Should be in the format of `arn:{partition}:kms:{region}:{account_id}:key/{key_id}` or `aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}`", +"type": "string" +}, +"keyType": { +"description": "Required. The type of algorithm used to encrypt the data.", +"enum": [ +"KEY_TYPE_UNSPECIFIED", +"XCHACHA20_POLY1305" +], +"enumDescriptions": [ +"Unspecified key type. Should never be used.", +"Algorithm XChaCha20-Poly1305" +], +"type": "string" +}, +"roleArn": { +"description": "Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of `arn:{partition}:iam::{account_id}:role/{role_name}`", +"type": "string" +} +}, +"type": "object" +}, +"Baseline": { +"description": "Baseline criteria against which insights are compared.", +"id": "Baseline", +"properties": { +"baselineLocation": { +"$ref": "Location", +"description": "The baseline location of the request. Baseline location is an OR-list of the requested regions." +}, +"locationAutoDetectionEnabled": { +"description": "If set to true, the service will try to automatically detect the baseline location for insights.", +"type": "boolean" +} +}, +"type": "object" +}, +"CartData": { +"description": "The cart data associated with the event.", +"id": "CartData", +"properties": { +"items": { +"description": "Optional. The list of items associated with the event.", +"items": { +"$ref": "Item" +}, +"type": "array" +}, +"merchantFeedLabel": { +"description": "Optional. The Merchant Center feed label associated with the feed of the items.", +"type": "string" +}, +"merchantFeedLanguageCode": { +"description": "Optional. The language code in ISO 639-1 associated with the Merchant Center feed of the items.where your items are uploaded.", +"type": "string" +}, +"merchantId": { +"description": "Optional. The Merchant Center ID associated with the items.", +"type": "string" +}, +"transactionDiscount": { +"description": "Optional. The sum of all discounts associated with the transaction.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"Consent": { +"description": "[Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user.", +"id": "Consent", +"properties": { +"adPersonalization": { +"description": "Optional. Represents if the user consents to ad personalization.", +"enum": [ +"CONSENT_STATUS_UNSPECIFIED", +"CONSENT_GRANTED", +"CONSENT_DENIED" +], +"enumDescriptions": [ +"Not specified.", +"Granted.", +"Denied." +], +"type": "string" +}, +"adUserData": { +"description": "Optional. Represents if the user consents to ad user data.", +"enum": [ +"CONSENT_STATUS_UNSPECIFIED", +"CONSENT_GRANTED", +"CONSENT_DENIED" +], +"enumDescriptions": [ +"Not specified.", +"Granted.", +"Denied." +], +"type": "string" +} +}, +"type": "object" +}, +"ContactIdInfo": { +"description": "Additional information when `CONTACT_ID` is one of the `upload_key_types`.", +"id": "ContactIdInfo", +"properties": { +"dataSourceType": { +"description": "Optional. Immutable. Source of the upload data", +"enum": [ +"DATA_SOURCE_TYPE_UNSPECIFIED", +"DATA_SOURCE_TYPE_FIRST_PARTY", +"DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU", +"DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE", +"DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA" +], +"enumDescriptions": [ +"Not specified.", +"The uploaded data is first-party data.", +"The uploaded data is from a third-party credit bureau.", +"The uploaded data is from a third-party voter file.", +"The uploaded data is third party partner data." +], +"type": "string" +}, +"matchRatePercentage": { +"description": "Output only. Match rate for customer match user lists.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"CustomVariable": { +"description": "Custom variable for ads conversions.", +"id": "CustomVariable", +"properties": { +"destinationReferences": { +"description": "Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.", +"items": { +"type": "string" +}, +"type": "array" +}, +"value": { +"description": "Optional. The value to store for the custom variable.", +"type": "string" +}, +"variable": { +"description": "Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.", +"type": "string" +} +}, +"type": "object" +}, +"Destination": { +"description": "The Google product you're sending data to. For example, a Google Ads account.", +"id": "Destination", +"properties": { +"linkedAccount": { +"$ref": "ProductAccount", +"description": "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`." +}, +"loginAccount": { +"$ref": "ProductAccount", +"description": "Optional. The account used to make this API call. To add or remove data from the `operating_account`, this `login_account` must have write access to the `operating_account`. For example, a manager account of the `operating_account`, or an account with an established link to the `operating_account`." +}, +"operatingAccount": { +"$ref": "ProductAccount", +"description": "Required. The account to send the data to or remove the data from." +}, +"productDestinationId": { +"description": "Required. The object within the product account to ingest into. For example, a Google Ads audience ID, a Display & Video 360 audience ID or a Google Ads conversion action ID.", +"type": "string" +}, +"reference": { +"description": "Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest.", +"type": "string" +} +}, +"type": "object" +}, +"DeviceInfo": { +"description": "Information about the device being used (if any) when the event happened.", +"id": "DeviceInfo", +"properties": { +"ipAddress": { +"description": "Optional. The IP address of the device for the given context. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details.", +"type": "string" +}, +"userAgent": { +"description": "Optional. The user-agent string of the device for the given context.", +"type": "string" +} +}, +"type": "object" +}, +"Empty": { +"description": "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); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"EncryptionInfo": { +"description": "Encryption information for the data being ingested.", +"id": "EncryptionInfo", +"properties": { +"awsWrappedKeyInfo": { +"$ref": "AwsWrappedKeyInfo", +"description": "Amazon Web Services wrapped key information." +}, +"gcpWrappedKeyInfo": { +"$ref": "GcpWrappedKeyInfo", +"description": "Google Cloud Platform wrapped key information." +} +}, +"type": "object" +}, +"ErrorCount": { +"description": "The error count for a given error reason.", +"id": "ErrorCount", +"properties": { +"reason": { +"description": "The error reason of the failed records.", +"enum": [ +"PROCESSING_ERROR_REASON_UNSPECIFIED", +"PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE", +"PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED", +"PROCESSING_ERROR_REASON_EVENT_TOO_OLD", +"PROCESSING_ERROR_REASON_DENIED_CONSENT", +"PROCESSING_ERROR_REASON_NO_CONSENT", +"PROCESSING_ERROR_REASON_UNKNOWN_CONSENT", +"PROCESSING_ERROR_REASON_DUPLICATE_GCLID", +"PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID", +"PROCESSING_ERROR_REASON_INVALID_GBRAID", +"PROCESSING_ERROR_REASON_INVALID_GCLID", +"PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID", +"PROCESSING_ERROR_REASON_INVALID_WBRAID", +"PROCESSING_ERROR_REASON_INTERNAL_ERROR", +"PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED", +"PROCESSING_ERROR_REASON_INVALID_EVENT", +"PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS", +"PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS", +"PROCESSING_ERROR_REASON_INVALID_FORMAT", +"PROCESSING_ERROR_REASON_DECRYPTION_ERROR", +"PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR", +"PROCESSING_ERROR_REASON_INVALID_WIP", +"PROCESSING_ERROR_REASON_INVALID_KEK", +"PROCESSING_ERROR_REASON_WIP_AUTH_FAILED", +"PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED", +"PROCESSING_ERROR_REASON_AWS_AUTH_FAILED", +"PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR", +"PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER" +], +"enumDescriptions": [ +"The processing error reason is unknown.", +"The custom variable is invalid.", +"The status of the custom variable is not enabled.", +"The conversion is older than max supported age.", +"The ad user data is denied, either by the user or in the advertiser default settings.", +"Advertiser did not give 3P consent for the Ads core platform services.", +"The overall consent (determined from row level consent, request level consent, and account settings) could not be determined for this user", +"A conversion with the same GCLID and conversion time already exists in the system.", +"A conversion with the same order id and conversion action combination was already uploaded.", +"The gbraid could not be decoded.", +"The google click ID could not be decoded.", +"Merchant id contains non-digit characters.", +"The wbraid could not be decoded.", +"Internal error.", +"Enhanced conversions terms are not signed in the destination account.", +"The event is invalid.", +"The matched transactions are less than the minimum threshold.", +"The transactions are less than the minimum threshold.", +"The event has format error.", +"The event has a decryption error.", +"The DEK failed to be decrypted.", +"The WIP is formatted incorrectly or the WIP does not exist.", +"The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.", +"The WIP could not be used because it was rejected by its attestation condition.", +"The system did not have the permissions needed to access the KEK.", +"The system failed to authenticate with AWS.", +"Failed to decrypt the UserIdentifier data using the DEK.", +"The user attempted to ingest events with an ad identifier that isn't from the operating account's ads." +], +"type": "string" +}, +"recordCount": { +"description": "The count of records that failed to upload for a given reason.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ErrorInfo": { +"description": "Error counts for each type of error.", +"id": "ErrorInfo", +"properties": { +"errorCounts": { +"description": "A list of errors and counts per error reason. May not be populated in all cases.", +"items": { +"$ref": "ErrorCount" +}, +"type": "array" +} +}, +"type": "object" +}, +"Event": { +"description": "An event representing a user interaction with an advertiser's website or app.", +"id": "Event", +"properties": { +"adIdentifiers": { +"$ref": "AdIdentifiers", +"description": "Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks)." +}, +"additionalEventParameters": { +"description": "Optional. A bucket of any [event parameters](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.", +"items": { +"$ref": "EventParameter" +}, +"type": "array" +}, +"cartData": { +"$ref": "CartData", +"description": "Optional. Information about the transaction and items associated with the event." +}, +"clientId": { +"description": "Optional. A unique identifier for the user instance of a web client for this GA4 web stream.", +"type": "string" +}, +"consent": { +"$ref": "Consent", +"description": "Optional. Information about whether the associated user has provided different types of consent." +}, +"conversionValue": { +"description": "Optional. The conversion value associated with the event, for value-based conversions.", +"format": "double", +"type": "number" +}, +"currency": { +"description": "Optional. The currency code associated with all monetary values within this event.", +"type": "string" +}, +"customVariables": { +"description": "Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).", +"items": { +"$ref": "CustomVariable" +}, +"type": "array" +}, +"destinationReferences": { +"description": "Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.", +"items": { +"type": "string" +}, +"type": "array" +}, +"eventDeviceInfo": { +"$ref": "DeviceInfo", +"description": "Optional. Information gathered about the device being used (if any) when the event happened." +}, +"eventName": { +"description": "Optional. The name of the event. Required for GA4 events.", +"type": "string" +}, +"eventSource": { +"description": "Optional. Signal for where the event happened (web, app, in-store, etc.).", +"enum": [ +"EVENT_SOURCE_UNSPECIFIED", +"WEB", +"APP", +"IN_STORE", +"PHONE", +"OTHER" +], +"enumDescriptions": [ +"Unspecified EventSource. Should never be used.", +"The event was generated from a web browser.", +"The event was generated from an app.", +"The event was generated from an in-store transaction.", +"The event was generated from a phone call.", +"The event was generated from other sources." +], +"type": "string" +}, +"eventTimestamp": { +"description": "Required. The time the event occurred.", +"format": "google-datetime", +"type": "string" +}, +"experimentalFields": { +"description": "Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.", +"items": { +"$ref": "ExperimentalField" +}, +"type": "array" +}, +"lastUpdatedTimestamp": { +"description": "Optional. The last time the event was updated.", +"format": "google-datetime", +"type": "string" +}, +"transactionId": { +"description": "Optional. The unique identifier for this event. Required for conversions using multiple data sources.", +"type": "string" +}, +"userData": { +"$ref": "UserData", +"description": "Optional. Pieces of user provided data, representing the user the event is associated with." +}, +"userId": { +"description": "Optional. A unique identifier for a user, as defined by the advertiser.", +"type": "string" +}, +"userProperties": { +"$ref": "UserProperties", +"description": "Optional. Advertiser-assessed information about the user at the time that the event happened." +} +}, +"type": "object" +}, +"EventParameter": { +"description": "Event parameter for GA4 events.", +"id": "EventParameter", +"properties": { +"parameterName": { +"description": "Required. The name of the parameter to use.", +"type": "string" +}, +"value": { +"description": "Required. The string representation of the value of the parameter to set.", +"type": "string" +} +}, +"type": "object" +}, +"ExperimentalField": { +"description": "Experimental field representing unofficial fields.", +"id": "ExperimentalField", +"properties": { +"field": { +"description": "Optional. The name of the field to use.", +"type": "string" +}, +"value": { +"description": "Optional. The value the field to set.", +"type": "string" +} +}, +"type": "object" +}, +"GcpWrappedKeyInfo": { +"description": "Information about the Google Cloud Platform wrapped key.", +"id": "GcpWrappedKeyInfo", +"properties": { +"encryptedDek": { +"description": "Required. The base64 encoded encrypted data encryption key.", +"type": "string" +}, +"kekUri": { +"description": "Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}` or `gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}`", +"type": "string" +}, +"keyType": { +"description": "Required. The type of algorithm used to encrypt the data.", +"enum": [ +"KEY_TYPE_UNSPECIFIED", +"XCHACHA20_POLY1305" +], +"enumDescriptions": [ +"Unspecified key type. Should never be used.", +"Algorithm XChaCha20-Poly1305" +], +"type": "string" +}, +"wipProvider": { +"description": "Required. The [Workload Identity](//cloud.google.com/iam/docs/workload-identity-federation) pool provider required to use KEK.", +"type": "string" +} +}, +"type": "object" +}, +"IngestAudienceMembersRequest": { +"description": "Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse.", +"id": "IngestAudienceMembersRequest", +"properties": { +"audienceMembers": { +"description": "Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.", +"items": { +"$ref": "AudienceMember" +}, +"type": "array" +}, +"consent": { +"$ref": "Consent", +"description": "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." +}, +"destinations": { +"description": "Required. The list of destinations to send the audience members to.", +"items": { +"$ref": "Destination" +}, +"type": "array" +}, +"encoding": { +"description": "Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.", +"enum": [ +"ENCODING_UNSPECIFIED", +"HEX", +"BASE64" +], +"enumDescriptions": [ +"Unspecified Encoding type. Should never be used.", +"Hex encoding.", +"Base 64 encoding." +], +"type": "string" +}, +"encryptionInfo": { +"$ref": "EncryptionInfo", +"description": "Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored." +}, +"termsOfService": { +"$ref": "TermsOfService", +"description": "Optional. The terms of service that the user has accepted/rejected." +}, +"validateOnly": { +"description": "Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.", +"type": "boolean" +} +}, +"type": "object" +}, +"IngestAudienceMembersResponse": { +"description": "Response from the IngestAudienceMembersRequest.", +"id": "IngestAudienceMembersResponse", +"properties": { +"requestId": { +"description": "The auto-generated ID of the request.", +"type": "string" +} +}, +"type": "object" +}, +"IngestAudienceMembersStatus": { +"description": "The status of the ingest audience members request.", +"id": "IngestAudienceMembersStatus", +"properties": { +"mobileDataIngestionStatus": { +"$ref": "IngestMobileDataStatus", +"description": "The status of the mobile data ingestion to the destination." +}, +"pairDataIngestionStatus": { +"$ref": "IngestPairDataStatus", +"description": "The status of the pair data ingestion to the destination." +}, +"ppidDataIngestionStatus": { +"$ref": "IngestPpidDataStatus", +"description": "The status of the ppid data ingestion to the destination." +}, +"userDataIngestionStatus": { +"$ref": "IngestUserDataStatus", +"description": "The status of the user data ingestion to the destination." +}, +"userIdDataIngestionStatus": { +"$ref": "IngestUserIdDataStatus", +"description": "The status of the user id data ingestion to the destination." +} +}, +"type": "object" +}, +"IngestEventsRequest": { +"description": "Request to upload audience members to the provided destinations. Returns an IngestEventsResponse.", +"id": "IngestEventsRequest", +"properties": { +"consent": { +"$ref": "Consent", +"description": "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 Event." }, -"Consent": { -"description": "[Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user.", -"id": "Consent", +"destinations": { +"description": "Required. The list of destinations to send the events to.", +"items": { +"$ref": "Destination" +}, +"type": "array" +}, +"encoding": { +"description": "Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.", +"enum": [ +"ENCODING_UNSPECIFIED", +"HEX", +"BASE64" +], +"enumDescriptions": [ +"Unspecified Encoding type. Should never be used.", +"Hex encoding.", +"Base 64 encoding." +], +"type": "string" +}, +"encryptionInfo": { +"$ref": "EncryptionInfo", +"description": "Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored." +}, +"events": { +"description": "Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.", +"items": { +"$ref": "Event" +}, +"type": "array" +}, +"validateOnly": { +"description": "Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.", +"type": "boolean" +} +}, +"type": "object" +}, +"IngestEventsResponse": { +"description": "Response from the IngestEventsRequest.", +"id": "IngestEventsResponse", "properties": { -"adPersonalization": { -"description": "Optional. Represents if the user consents to ad personalization.", +"requestId": { +"description": "The auto-generated ID of the request.", +"type": "string" +} +}, +"type": "object" +}, +"IngestEventsStatus": { +"description": "The status of the events ingestion to the destination.", +"id": "IngestEventsStatus", +"properties": { +"recordCount": { +"description": "The total count of events sent in the upload request. Includes all events in the request, regardless of whether they were successfully ingested or not.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"IngestMobileDataStatus": { +"description": "The status of the mobile data ingestion to the destination containing stats related to the ingestion.", +"id": "IngestMobileDataStatus", +"properties": { +"mobileIdCount": { +"description": "The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not.", +"format": "int64", +"type": "string" +}, +"recordCount": { +"description": "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.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"IngestPairDataStatus": { +"description": "The status of the pair data ingestion to the destination containing stats related to the ingestion.", +"id": "IngestPairDataStatus", +"properties": { +"pairIdCount": { +"description": "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.", +"format": "int64", +"type": "string" +}, +"recordCount": { +"description": "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.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"IngestPpidDataStatus": { +"description": "The status of the ppid data ingestion to the destination containing stats related to the ingestion.", +"id": "IngestPpidDataStatus", +"properties": { +"ppidCount": { +"description": "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.", +"format": "int64", +"type": "string" +}, +"recordCount": { +"description": "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.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"IngestUserDataStatus": { +"description": "The status of the user data ingestion to the destination containing stats related to the ingestion.", +"id": "IngestUserDataStatus", +"properties": { +"recordCount": { +"description": "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.", +"format": "int64", +"type": "string" +}, +"uploadMatchRateRange": { +"description": "The match rate range of the upload.", "enum": [ -"CONSENT_STATUS_UNSPECIFIED", -"CONSENT_GRANTED", -"CONSENT_DENIED" +"MATCH_RATE_RANGE_UNKNOWN", +"MATCH_RATE_RANGE_NOT_ELIGIBLE", +"MATCH_RATE_RANGE_LESS_THAN_20", +"MATCH_RATE_RANGE_20_TO_30", +"MATCH_RATE_RANGE_31_TO_40", +"MATCH_RATE_RANGE_41_TO_50", +"MATCH_RATE_RANGE_51_TO_60", +"MATCH_RATE_RANGE_61_TO_70", +"MATCH_RATE_RANGE_71_TO_80", +"MATCH_RATE_RANGE_81_TO_90", +"MATCH_RATE_RANGE_91_TO_100" ], "enumDescriptions": [ -"Not specified.", -"Granted.", -"Denied." +"The match rate range is unknown.", +"The match rate range is not eligible.", +"The match rate range is less than 20% (in the interval `[0, 20)`).", +"The match rate range is between 20% and 30% (in the interval `[20, 31)`).", +"The match rate range is between 31% and 40% (in the interval `[31, 41)`).", +"The match rate range is between 41% and 50% (in the interval `[41, 51)`).", +"The match rate range is between 51% and 60% (in the interval `[51, 61)`.", +"The match rate range is between 61% and 70% (in the interval `[61, 71)`).", +"The match rate range is between 71% and 80% (in the interval `[71, 81)`).", +"The match rate range is between 81% and 90% (in the interval `[81, 91)`).", +"The match rate range is between 91% and 100% (in the interval `[91, 100]`)." ], "type": "string" }, -"adUserData": { -"description": "Optional. Represents if the user consents to ad user data.", +"userIdentifierCount": { +"description": "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.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"IngestUserIdDataStatus": { +"description": "The status of the user id data ingestion to the destination containing stats related to the ingestion.", +"id": "IngestUserIdDataStatus", +"properties": { +"recordCount": { +"description": "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.", +"format": "int64", +"type": "string" +}, +"userIdCount": { +"description": "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.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"IngestedUserListInfo": { +"description": "Represents a user list that is populated by user provided data.", +"id": "IngestedUserListInfo", +"properties": { +"contactIdInfo": { +"$ref": "ContactIdInfo", +"description": "Optional. Additional information when `CONTACT_ID` is one of the `upload_key_types`." +}, +"mobileIdInfo": { +"$ref": "MobileIdInfo", +"description": "Optional. Additional information when `MOBILE_ID` is one of the `upload_key_types`." +}, +"pairIdInfo": { +"$ref": "PairIdInfo", +"description": "Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners." +}, +"partnerAudienceInfo": { +"$ref": "PartnerAudienceInfo", +"description": "Optional. Additional information for partner audiences. This feature is only available to data partners." +}, +"pseudonymousIdInfo": { +"$ref": "PseudonymousIdInfo", +"description": "Optional. Additional information for `PSEUDONYMOUS_ID` is one of the `upload_key_types`." +}, +"uploadKeyTypes": { +"description": "Required. Immutable. Upload key types of this user list.", +"items": { "enum": [ -"CONSENT_STATUS_UNSPECIFIED", -"CONSENT_GRANTED", -"CONSENT_DENIED" +"UPLOAD_KEY_TYPE_UNSPECIFIED", +"CONTACT_ID", +"MOBILE_ID", +"USER_ID", +"PAIR_ID", +"PSEUDONYMOUS_ID" ], "enumDescriptions": [ "Not specified.", -"Granted.", -"Denied." +"Customer info such as email address, phone number or physical address.", +"Mobile advertising ids.", +"Third party provided user ids.", +"Publisher advertiser identity reconciliation ids.", +"Data Management Platform IDs: - Google User ID - Partner Provided ID - Publisher Provided ID - iOS IDFA - Android advertising ID - Roku ID - Amazon Fire TV ID - Xbox or Microsoft ID" ], "type": "string" +}, +"type": "array" +}, +"userIdInfo": { +"$ref": "UserIdInfo", +"description": "Optional. Additional information when `USER_ID` is one of the `upload_key_types`." } }, "type": "object" }, -"CustomVariable": { -"description": "Custom variable for ads conversions.", -"id": "CustomVariable", +"Item": { +"description": "Represents an item in the cart associated with the event.", +"id": "Item", "properties": { -"destinationReferences": { -"description": "Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.", +"additionalItemParameters": { +"description": "Optional. A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.", "items": { -"type": "string" +"$ref": "ItemParameter" }, "type": "array" }, -"value": { -"description": "Optional. The value to store for the custom variable.", +"itemId": { +"description": "Optional. A unique identifier to reference the item.", "type": "string" }, -"variable": { -"description": "Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.", +"merchantProductId": { +"description": "Optional. The product ID within the Merchant Center account.", +"type": "string" +}, +"quantity": { +"description": "Optional. The number of this item associated with the event.", +"format": "int64", "type": "string" +}, +"unitPrice": { +"description": "Optional. The unit price excluding tax, shipping, and any transaction level discounts.", +"format": "double", +"type": "number" } }, "type": "object" }, -"Destination": { -"description": "The Google product you're sending data to. For example, a Google Ads account.", -"id": "Destination", +"ItemParameter": { +"description": "A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.", +"id": "ItemParameter", "properties": { -"linkedAccount": { -"$ref": "ProductAccount", -"description": "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`." +"parameterName": { +"description": "Required. The name of the parameter to use.", +"type": "string" }, -"loginAccount": { -"$ref": "ProductAccount", -"description": "Optional. The account used to make this API call. To add or remove data from the `operating_account`, this `login_account` must have write access to the `operating_account`. For example, a manager account of the `operating_account`, or an account with an established link to the `operating_account`." +"value": { +"description": "Required. The string representation of the value of the parameter to set.", +"type": "string" +} }, -"operatingAccount": { -"$ref": "ProductAccount", -"description": "Required. The account to send the data to or remove the data from." +"type": "object" }, -"productDestinationId": { -"description": "Required. The object within the product account to ingest into. For example, a Google Ads audience ID, a Display & Video 360 audience ID or a Google Ads conversion action ID.", +"ListUserListDirectLicensesResponse": { +"description": "Response from the ListUserListDirectLicensesRequest.", +"id": "ListUserListDirectLicensesResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, -"reference": { -"description": "Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest.", -"type": "string" +"userListDirectLicenses": { +"description": "The licenses for the given user list in the request.", +"items": { +"$ref": "UserListDirectLicense" +}, +"type": "array" } }, "type": "object" }, -"DeviceInfo": { -"description": "Information about the device being used (if any) when the event happened.", -"id": "DeviceInfo", +"ListUserListGlobalLicenseCustomerInfosResponse": { +"description": "Response from the ListUserListGlobalLicensesCustomerInfoRequest.", +"id": "ListUserListGlobalLicenseCustomerInfosResponse", "properties": { -"ipAddress": { -"description": "Optional. The IP address of the device for the given context. **Note:** Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the [About offline conversion imports](https://support.google.com/google-ads/answer/2998031) page for more details.", +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, -"userAgent": { -"description": "Optional. The user-agent string of the device for the given context.", -"type": "string" +"userListGlobalLicenseCustomerInfos": { +"description": "The customer information for the given license in the request.", +"items": { +"$ref": "UserListGlobalLicenseCustomerInfo" +}, +"type": "array" } }, "type": "object" }, -"EncryptionInfo": { -"description": "Encryption information for the data being ingested.", -"id": "EncryptionInfo", +"ListUserListGlobalLicensesResponse": { +"description": "Response from the ListUserListGlobalLicensesRequest.", +"id": "ListUserListGlobalLicensesResponse", "properties": { -"awsWrappedKeyInfo": { -"$ref": "AwsWrappedKeyInfo", -"description": "Amazon Web Services wrapped key information." +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" }, -"gcpWrappedKeyInfo": { -"$ref": "GcpWrappedKeyInfo", -"description": "Google Cloud Platform wrapped key information." +"userListGlobalLicenses": { +"description": "The licenses for the given user list in the request.", +"items": { +"$ref": "UserListGlobalLicense" +}, +"type": "array" } }, "type": "object" }, -"ErrorCount": { -"description": "The error count for a given error reason.", -"id": "ErrorCount", +"ListUserListsResponse": { +"description": "Response message for ListUserLists.", +"id": "ListUserListsResponse", "properties": { -"reason": { -"description": "The error reason of the failed records.", -"enum": [ -"PROCESSING_ERROR_REASON_UNSPECIFIED", -"PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE", -"PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED", -"PROCESSING_ERROR_REASON_EVENT_TOO_OLD", -"PROCESSING_ERROR_REASON_DENIED_CONSENT", -"PROCESSING_ERROR_REASON_NO_CONSENT", -"PROCESSING_ERROR_REASON_UNKNOWN_CONSENT", -"PROCESSING_ERROR_REASON_DUPLICATE_GCLID", -"PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID", -"PROCESSING_ERROR_REASON_INVALID_GBRAID", -"PROCESSING_ERROR_REASON_INVALID_GCLID", -"PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID", -"PROCESSING_ERROR_REASON_INVALID_WBRAID", -"PROCESSING_ERROR_REASON_INTERNAL_ERROR", -"PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED", -"PROCESSING_ERROR_REASON_INVALID_EVENT", -"PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS", -"PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS", -"PROCESSING_ERROR_REASON_INVALID_FORMAT", -"PROCESSING_ERROR_REASON_DECRYPTION_ERROR", -"PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR", -"PROCESSING_ERROR_REASON_INVALID_WIP", -"PROCESSING_ERROR_REASON_INVALID_KEK", -"PROCESSING_ERROR_REASON_WIP_AUTH_FAILED", -"PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED", -"PROCESSING_ERROR_REASON_AWS_AUTH_FAILED", -"PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR", -"PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER" -], -"enumDescriptions": [ -"The processing error reason is unknown.", -"The custom variable is invalid.", -"The status of the custom variable is not enabled.", -"The conversion is older than max supported age.", -"The ad user data is denied, either by the user or in the advertiser default settings.", -"Advertiser did not give 3P consent for the Ads core platform services.", -"The overall consent (determined from row level consent, request level consent, and account settings) could not be determined for this user", -"A conversion with the same GCLID and conversion time already exists in the system.", -"A conversion with the same order id and conversion action combination was already uploaded.", -"The gbraid could not be decoded.", -"The google click ID could not be decoded.", -"Merchant id contains non-digit characters.", -"The wbraid could not be decoded.", -"Internal error.", -"Enhanced conversions terms are not signed in the destination account.", -"The event is invalid.", -"The matched transactions are less than the minimum threshold.", -"The transactions are less than the minimum threshold.", -"The event has format error.", -"The event has a decryption error.", -"The DEK failed to be decrypted.", -"The WIP is formatted incorrectly or the WIP does not exist.", -"The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.", -"The WIP could not be used because it was rejected by its attestation condition.", -"The system did not have the permissions needed to access the KEK.", -"The system failed to authenticate with AWS.", -"Failed to decrypt the UserIdentifier data using the DEK.", -"The user attempted to ingest events with an ad identifier that isn't from the operating account's ads." -], +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, -"recordCount": { -"description": "The count of records that failed to upload for a given reason.", -"format": "int64", -"type": "string" +"userLists": { +"description": "The user lists from the specified account.", +"items": { +"$ref": "UserList" +}, +"type": "array" } }, "type": "object" }, -"ErrorInfo": { -"description": "Error counts for each type of error.", -"id": "ErrorInfo", +"Location": { +"description": "The baseline location of the request. Baseline location is on OR-list of ISO 3166-1 alpha-2 region codes of the requested regions.", +"id": "Location", "properties": { -"errorCounts": { -"description": "A list of errors and counts per error reason. May not be populated in all cases.", +"regionCodes": { +"description": "List of ISO 3166-1 alpha-2 region codes.", "items": { -"$ref": "ErrorCount" +"type": "string" }, "type": "array" } }, "type": "object" }, -"Event": { -"description": "An event representing a user interaction with an advertiser's website or app.", -"id": "Event", +"MarketingDataInsight": { +"description": "Insights for marketing data. This feature is only available to data partners.", +"id": "MarketingDataInsight", "properties": { -"adIdentifiers": { -"$ref": "AdIdentifiers", -"description": "Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks)." -}, -"additionalEventParameters": { -"description": "Optional. A bucket of any [event parameters](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.", +"attributes": { +"description": "Insights for values of a given dimension.", "items": { -"$ref": "EventParameter" +"$ref": "MarketingDataInsightsAttribute" }, "type": "array" }, -"cartData": { -"$ref": "CartData", -"description": "Optional. Information about the transaction and items associated with the event." +"dimension": { +"description": "The dimension to which the insight belongs.", +"enum": [ +"AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED", +"AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN", +"AFFINITY_USER_INTEREST", +"IN_MARKET_USER_INTEREST", +"AGE_RANGE", +"GENDER" +], +"enumDescriptions": [ +"Not specified.", +"The value is unknown in this version.", +"An Affinity UserInterest.", +"An In-Market UserInterest.", +"An age range.", +"A gender." +], +"type": "string" +} }, -"clientId": { -"description": "Optional. A unique identifier for the user instance of a web client for this GA4 web stream.", +"type": "object" +}, +"MarketingDataInsightsAttribute": { +"description": "Insights for a collection of related attributes of the same dimension.", +"id": "MarketingDataInsightsAttribute", +"properties": { +"ageRange": { +"description": "Age range of the audience for which the lift is provided.", +"enum": [ +"AGE_RANGE_UNSPECIFIED", +"AGE_RANGE_UNKNOWN", +"AGE_RANGE_18_24", +"AGE_RANGE_25_34", +"AGE_RANGE_35_44", +"AGE_RANGE_45_54", +"AGE_RANGE_55_64", +"AGE_RANGE_65_UP" +], +"enumDescriptions": [ +"Not specified.", +"Unknown.", +"Between 18 and 24 years old.", +"Between 25 and 34 years old.", +"Between 35 and 44 years old.", +"Between 45 and 54 years old.", +"Between 55 and 64 years old.", +"65 years old and beyond." +], "type": "string" }, -"consent": { -"$ref": "Consent", -"description": "Optional. Information about whether the associated user has provided different types of consent." +"gender": { +"description": "Gender of the audience for which the lift is provided.", +"enum": [ +"GENDER_UNSPECIFIED", +"GENDER_UNKNOWN", +"GENDER_MALE", +"GENDER_FEMALE" +], +"enumDescriptions": [ +"Not specified.", +"Unknown.", +"Male.", +"Female." +], +"type": "string" }, -"conversionValue": { -"description": "Optional. The conversion value associated with the event, for value-based conversions.", -"format": "double", +"lift": { +"description": "Measure of lift that the audience has for the attribute value as compared to the baseline. Range [0-1].", +"format": "float", "type": "number" }, -"currency": { -"description": "Optional. The currency code associated with all monetary values within this event.", +"userInterestId": { +"description": "The user interest ID.", +"format": "int64", "type": "string" +} }, -"customVariables": { -"description": "Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).", -"items": { -"$ref": "CustomVariable" -}, -"type": "array" +"type": "object" }, -"destinationReferences": { -"description": "Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.", +"MobileData": { +"description": "Mobile IDs for the audience. At least one mobile ID is required.", +"id": "MobileData", +"properties": { +"mobileIds": { +"description": "Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 `mobileIds` can be provided in a single AudienceMember.", "items": { "type": "string" }, "type": "array" +} }, -"eventDeviceInfo": { -"$ref": "DeviceInfo", -"description": "Optional. Information gathered about the device being used (if any) when the event happened." +"type": "object" }, -"eventName": { -"description": "Optional. The name of the event. Required for GA4 events.", +"MobileIdInfo": { +"description": "Additional information when `MOBILE_ID` is one of the `upload_key_types`.", +"id": "MobileIdInfo", +"properties": { +"appId": { +"description": "Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.", "type": "string" }, -"eventSource": { -"description": "Optional. Signal for where the event happened (web, app, in-store, etc.).", +"dataSourceType": { +"description": "Optional. Immutable. Source of the upload data.", "enum": [ -"EVENT_SOURCE_UNSPECIFIED", -"WEB", -"APP", -"IN_STORE", -"PHONE", -"OTHER" +"DATA_SOURCE_TYPE_UNSPECIFIED", +"DATA_SOURCE_TYPE_FIRST_PARTY", +"DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU", +"DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE", +"DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA" ], "enumDescriptions": [ -"Unspecified EventSource. Should never be used.", -"The event was generated from a web browser.", -"The event was generated from an app.", -"The event was generated from an in-store transaction.", -"The event was generated from a phone call.", -"The event was generated from other sources." +"Not specified.", +"The uploaded data is first-party data.", +"The uploaded data is from a third-party credit bureau.", +"The uploaded data is from a third-party voter file.", +"The uploaded data is third party partner data." ], "type": "string" }, -"eventTimestamp": { -"description": "Required. The time the event occurred.", -"format": "google-datetime", +"keySpace": { +"description": "Required. Immutable. The key space of mobile IDs.", +"enum": [ +"KEY_SPACE_UNSPECIFIED", +"IOS", +"ANDROID" +], +"enumDescriptions": [ +"Not specified.", +"The iOS keyspace.", +"The Android keyspace." +], "type": "string" +} }, -"experimentalFields": { -"description": "Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.", +"type": "object" +}, +"PairData": { +"description": "[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.", +"id": "PairData", +"properties": { +"pairIds": { +"description": "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.", "items": { -"$ref": "ExperimentalField" +"type": "string" }, "type": "array" +} }, -"lastUpdatedTimestamp": { -"description": "Optional. The last time the event was updated.", -"format": "google-datetime", +"type": "object" +}, +"PairIdInfo": { +"description": "Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.", +"id": "PairIdInfo", +"properties": { +"advertiserIdentifierCount": { +"description": "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.", +"format": "int64", +"readOnly": true, "type": "string" }, -"transactionId": { -"description": "Optional. The unique identifier for this event. Required for conversions using multiple data sources.", +"cleanRoomIdentifier": { +"description": "Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.", "type": "string" }, -"userData": { -"$ref": "UserData", -"description": "Optional. Pieces of user provided data, representing the user the event is associated with." +"matchRatePercentage": { +"description": "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.", +"format": "int32", +"readOnly": true, +"type": "integer" }, -"userId": { -"description": "Optional. A unique identifier for a user, as defined by the advertiser.", +"publisherId": { +"description": "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.", +"format": "int64", "type": "string" }, -"userProperties": { -"$ref": "UserProperties", -"description": "Optional. Advertiser-assessed information about the user at the time that the event happened." +"publisherName": { +"description": "Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.", +"type": "string" } }, "type": "object" }, -"EventParameter": { -"description": "Event parameter for GA4 events.", -"id": "EventParameter", +"PartnerAudienceInfo": { +"description": "Additional information for partner audiences. This feature is only available to data partners.", +"id": "PartnerAudienceInfo", "properties": { -"parameterName": { -"description": "Required. The name of the parameter to use.", +"commercePartner": { +"description": "Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.", "type": "string" }, -"value": { -"description": "Required. The string representation of the value of the parameter to set.", +"partnerAudienceSource": { +"description": "Required. Immutable. The source of the partner audience.", +"enum": [ +"PARTNER_AUDIENCE_SOURCE_UNSPECIFIED", +"COMMERCE_AUDIENCE", +"LINEAR_TV_AUDIENCE", +"AGENCY_PROVIDER_AUDIENCE" +], +"enumDescriptions": [ +"Not specified.", +"Partner Audience source is commerce audience.", +"Partner Audience source is linear TV audience.", +"Partner Audience source is agency/provider audience." +], "type": "string" } }, "type": "object" }, -"ExperimentalField": { -"description": "Experimental field representing unofficial fields.", -"id": "ExperimentalField", +"PartnerLink": { +"description": "A partner link between an owning account and a partner account.", +"id": "PartnerLink", "properties": { -"field": { -"description": "Optional. The name of the field to use.", +"name": { +"description": "Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}", +"type": "string" +}, +"owningAccount": { +"$ref": "ProductAccount", +"description": "Required. The owning account granting access to the partner account." +}, +"partnerAccount": { +"$ref": "ProductAccount", +"description": "Required. The partner account granted access by the owning account." +}, +"partnerLinkId": { +"description": "Output only. The partner link ID.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"PpidData": { +"description": "Publisher provided identifiers data holding the ppids. At least one ppid is required. This feature is only available to data partners.", +"id": "PpidData", +"properties": { +"ppids": { +"description": "Required. The list of publisher provided identifiers for a user.", +"items": { "type": "string" }, -"value": { -"description": "Optional. The value the field to set.", -"type": "string" +"type": "array" } }, "type": "object" }, -"GcpWrappedKeyInfo": { -"description": "Information about the Google Cloud Platform wrapped key.", -"id": "GcpWrappedKeyInfo", +"ProductAccount": { +"description": "Represents a specific account.", +"id": "ProductAccount", "properties": { -"encryptedDek": { -"description": "Required. The base64 encoded encrypted data encryption key.", +"accountId": { +"description": "Required. The ID of the account. For example, your Google Ads account ID.", "type": "string" }, -"kekUri": { -"description": "Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}` or `gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}`", +"accountType": { +"description": "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.", +"enum": [ +"ACCOUNT_TYPE_UNSPECIFIED", +"GOOGLE_ADS", +"DISPLAY_VIDEO_PARTNER", +"DISPLAY_VIDEO_ADVERTISER", +"DATA_PARTNER", +"GOOGLE_ANALYTICS_PROPERTY", +"GOOGLE_AD_MANAGER_AUDIENCE_LINK" +], +"enumDescriptions": [ +"Unspecified product. Should never be used.", +"Google Ads.", +"Display & Video 360 partner.", +"Display & Video 360 advertiser.", +"Data Partner.", +"Google Analytics.", +"Google Ad Manager audience link." +], "type": "string" }, -"keyType": { -"description": "Required. The type of algorithm used to encrypt the data.", +"product": { +"deprecated": true, +"description": "Deprecated. Use `account_type` instead.", "enum": [ -"KEY_TYPE_UNSPECIFIED", -"XCHACHA20_POLY1305" +"PRODUCT_UNSPECIFIED", +"GOOGLE_ADS", +"DISPLAY_VIDEO_PARTNER", +"DISPLAY_VIDEO_ADVERTISER", +"DATA_PARTNER" ], "enumDescriptions": [ -"Unspecified key type. Should never be used.", -"Algorithm XChaCha20-Poly1305" +"Unspecified product. Should never be used.", +"Google Ads.", +"Display & Video 360 partner.", +"Display & Video 360 advertiser.", +"Data Partner." ], "type": "string" +} }, -"wipProvider": { -"description": "Required. The [Workload Identity](//cloud.google.com/iam/docs/workload-identity-federation) pool provider required to use KEK.", +"type": "object" +}, +"PseudonymousIdInfo": { +"description": "Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`.", +"id": "PseudonymousIdInfo", +"properties": { +"billableRecordCount": { +"description": "Optional. Immutable. The number of billable records (e.g. uploaded or matched).", +"format": "int64", +"type": "string" +}, +"syncStatus": { +"description": "Output only. Sync status of the user list.", +"enum": [ +"SYNC_STATUS_UNSPECIFIED", +"CREATED", +"READY_FOR_USE", +"FAILED" +], +"enumDescriptions": [ +"Not specified.", +"The user list has been created as a placeholder. List contents and/or metadata are still being synced. The user list is not ready for use.", +"The user list is ready for use. Contents and cookies have been synced correctly.", +"An error has occurred syncing user list contents and/or metadata. The user list cannot be used." +], +"readOnly": true, "type": "string" } }, "type": "object" }, -"IngestAudienceMembersRequest": { -"description": "Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse.", -"id": "IngestAudienceMembersRequest", +"RemoveAudienceMembersRequest": { +"description": "Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse.", +"id": "RemoveAudienceMembersRequest", "properties": { "audienceMembers": { -"description": "Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.", +"description": "Required. The list of users to remove.", "items": { "$ref": "AudienceMember" }, "type": "array" }, -"consent": { -"$ref": "Consent", -"description": "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." -}, "destinations": { -"description": "Required. The list of destinations to send the audience members to.", +"description": "Required. The list of destinations to remove the users from.", "items": { "$ref": "Destination" }, "type": "array" }, "encoding": { -"description": "Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.", +"description": "Optional. Required for UserData uploads. The encoding type of the user identifiers. Applies to only the outer encoding for encrypted user identifiers. For non `UserData` uploads, this field is ignored.", "enum": [ "ENCODING_UNSPECIFIED", "HEX", @@ -757,10 +2235,6 @@ "$ref": "EncryptionInfo", "description": "Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored." }, -"termsOfService": { -"$ref": "TermsOfService", -"description": "Optional. The terms of service that the user has accepted/rejected." -}, "validateOnly": { "description": "Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.", "type": "boolean" @@ -768,9 +2242,9 @@ }, "type": "object" }, -"IngestAudienceMembersResponse": { -"description": "Response from the IngestAudienceMembersRequest.", -"id": "IngestAudienceMembersResponse", +"RemoveAudienceMembersResponse": { +"description": "Response from the RemoveAudienceMembersRequest.", +"id": "RemoveAudienceMembersResponse", "properties": { "requestId": { "description": "The auto-generated ID of the request.", @@ -779,564 +2253,852 @@ }, "type": "object" }, -"IngestAudienceMembersStatus": { -"description": "The status of the ingest audience members request.", -"id": "IngestAudienceMembersStatus", +"RemoveAudienceMembersStatus": { +"description": "The status of the remove audience members request.", +"id": "RemoveAudienceMembersStatus", "properties": { -"mobileDataIngestionStatus": { -"$ref": "IngestMobileDataStatus", -"description": "The status of the mobile data ingestion to the destination." +"mobileDataRemovalStatus": { +"$ref": "RemoveMobileDataStatus", +"description": "The status of the mobile data removal from the destination." }, -"pairDataIngestionStatus": { -"$ref": "IngestPairDataStatus", -"description": "The status of the pair data ingestion to the destination." +"pairDataRemovalStatus": { +"$ref": "RemovePairDataStatus", +"description": "The status of the pair data removal from the destination." }, -"userDataIngestionStatus": { -"$ref": "IngestUserDataStatus", -"description": "The status of the user data ingestion to the destination." +"ppidDataRemovalStatus": { +"$ref": "RemovePpidDataStatus", +"description": "The status of the ppid data removal from the destination." +}, +"userDataRemovalStatus": { +"$ref": "RemoveUserDataStatus", +"description": "The status of the user data removal from the destination." +}, +"userIdDataRemovalStatus": { +"$ref": "RemoveUserIdDataStatus", +"description": "The status of the user id data removal from the destination." } }, "type": "object" }, -"IngestEventsRequest": { -"description": "Request to upload audience members to the provided destinations. Returns an IngestEventsResponse.", -"id": "IngestEventsRequest", +"RemoveMobileDataStatus": { +"description": "The status of the mobile data removal from the destination.", +"id": "RemoveMobileDataStatus", "properties": { -"consent": { -"$ref": "Consent", -"description": "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 Event." +"mobileIdCount": { +"description": "The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not.", +"format": "int64", +"type": "string" }, -"destinations": { -"description": "Required. The list of destinations to send the events to.", -"items": { -"$ref": "Destination" +"recordCount": { +"description": "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.", +"format": "int64", +"type": "string" +} }, -"type": "array" +"type": "object" }, -"encoding": { -"description": "Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.", +"RemovePairDataStatus": { +"description": "The status of the pair data removal from the destination.", +"id": "RemovePairDataStatus", +"properties": { +"pairIdCount": { +"description": "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.", +"format": "int64", +"type": "string" +}, +"recordCount": { +"description": "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.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"RemovePpidDataStatus": { +"description": "The status of the ppid data removal from the destination.", +"id": "RemovePpidDataStatus", +"properties": { +"ppidCount": { +"description": "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.", +"format": "int64", +"type": "string" +}, +"recordCount": { +"description": "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.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"RemoveUserDataStatus": { +"description": "The status of the user data removal from the destination.", +"id": "RemoveUserDataStatus", +"properties": { +"recordCount": { +"description": "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.", +"format": "int64", +"type": "string" +}, +"userIdentifierCount": { +"description": "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.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"RemoveUserIdDataStatus": { +"description": "The status of the user id data removal from the destination.", +"id": "RemoveUserIdDataStatus", +"properties": { +"recordCount": { +"description": "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.", +"format": "int64", +"type": "string" +}, +"userIdCount": { +"description": "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.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"RequestStatusPerDestination": { +"description": "A request status per destination.", +"id": "RequestStatusPerDestination", +"properties": { +"audienceMembersIngestionStatus": { +"$ref": "IngestAudienceMembersStatus", +"description": "The status of the ingest audience members request." +}, +"audienceMembersRemovalStatus": { +"$ref": "RemoveAudienceMembersStatus", +"description": "The status of the remove audience members request." +}, +"destination": { +"$ref": "Destination", +"description": "A destination within a DM API request." +}, +"errorInfo": { +"$ref": "ErrorInfo", +"description": "An error info error containing the error reason and error counts related to the upload." +}, +"eventsIngestionStatus": { +"$ref": "IngestEventsStatus", +"description": "The status of the ingest events request." +}, +"requestStatus": { +"description": "The request status of the destination.", "enum": [ -"ENCODING_UNSPECIFIED", -"HEX", -"BASE64" +"REQUEST_STATUS_UNKNOWN", +"SUCCESS", +"PROCESSING", +"FAILED", +"PARTIAL_SUCCESS" ], "enumDescriptions": [ -"Unspecified Encoding type. Should never be used.", -"Hex encoding.", -"Base 64 encoding." +"The request status is unknown.", +"The request succeeded.", +"The request is processing.", +"The request failed.", +"The request partially succeeded." ], "type": "string" }, -"encryptionInfo": { -"$ref": "EncryptionInfo", -"description": "Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored." +"warningInfo": { +"$ref": "WarningInfo", +"description": "A warning info containing the warning reason and warning counts related to the upload." +} +}, +"type": "object" +}, +"RetrieveInsightsRequest": { +"description": "Request message for DM API MarketingDataInsightsService.RetrieveInsights", +"id": "RetrieveInsightsRequest", +"properties": { +"baseline": { +"$ref": "Baseline", +"description": "Required. Baseline for the insights requested." +}, +"userListId": { +"description": "Required. The user list ID for which insights are requested.", +"type": "string" +} }, -"events": { -"description": "Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.", +"type": "object" +}, +"RetrieveInsightsResponse": { +"description": "Response message for DM API MarketingDataInsightsService.RetrieveInsights", +"id": "RetrieveInsightsResponse", +"properties": { +"marketingDataInsights": { +"description": "Contains the insights for the marketing data.", "items": { -"$ref": "Event" +"$ref": "MarketingDataInsight" }, "type": "array" -}, -"validateOnly": { -"description": "Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.", -"type": "boolean" } }, "type": "object" }, -"IngestEventsResponse": { -"description": "Response from the IngestEventsRequest.", -"id": "IngestEventsResponse", +"RetrieveRequestStatusResponse": { +"description": "Response from the RetrieveRequestStatusRequest.", +"id": "RetrieveRequestStatusResponse", "properties": { -"requestId": { -"description": "The auto-generated ID of the request.", -"type": "string" +"requestStatusPerDestination": { +"description": "A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request.", +"items": { +"$ref": "RequestStatusPerDestination" +}, +"type": "array" } }, "type": "object" }, -"IngestEventsStatus": { -"description": "The status of the events ingestion to the destination.", -"id": "IngestEventsStatus", +"SearchPartnerLinksResponse": { +"description": "Response from the SearchPartnerLinksRequest.", +"id": "SearchPartnerLinksResponse", "properties": { -"recordCount": { -"description": "The total count of events sent in the upload request. Includes all events in the request, regardless of whether they were successfully ingested or not.", -"format": "int64", +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" +}, +"partnerLinks": { +"description": "The partner links for the given account.", +"items": { +"$ref": "PartnerLink" +}, +"type": "array" } }, "type": "object" }, -"IngestMobileDataStatus": { -"description": "The status of the mobile data ingestion to the destination containing stats related to the ingestion.", -"id": "IngestMobileDataStatus", +"SizeInfo": { +"description": "Estimated number of members in this user list in different target networks.", +"id": "SizeInfo", "properties": { -"mobileIdCount": { -"description": "The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not.", +"displayNetworkMembersCount": { +"description": "Output only. Estimated number of members in this user list, on the Google Display Network.", "format": "int64", +"readOnly": true, "type": "string" }, -"recordCount": { -"description": "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.", +"searchNetworkMembersCount": { +"description": "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.", "format": "int64", +"readOnly": true, "type": "string" } }, "type": "object" }, -"IngestPairDataStatus": { -"description": "The status of the pair data ingestion to the destination containing stats related to the ingestion.", -"id": "IngestPairDataStatus", +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for 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).", +"id": "Status", "properties": { -"pairIdCount": { -"description": "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.", -"format": "int64", -"type": "string" +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" }, -"recordCount": { -"description": "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.", -"format": "int64", +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "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.", "type": "string" } }, "type": "object" }, -"IngestUserDataStatus": { -"description": "The status of the user data ingestion to the destination containing stats related to the ingestion.", -"id": "IngestUserDataStatus", +"TargetNetworkInfo": { +"description": "Eligibility information for different target networks.", +"id": "TargetNetworkInfo", "properties": { -"recordCount": { -"description": "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.", -"format": "int64", -"type": "string" +"eligibleForDisplay": { +"description": "Output only. Indicates this user list is eligible for Google Display Network.", +"readOnly": true, +"type": "boolean" }, -"uploadMatchRateRange": { -"description": "The match rate range of the upload.", +"eligibleForSearch": { +"description": "Optional. Indicates if this user list is eligible for Google Search Network.", +"type": "boolean" +} +}, +"type": "object" +}, +"TermsOfService": { +"description": "The terms of service that the user has accepted/rejected.", +"id": "TermsOfService", +"properties": { +"customerMatchTermsOfServiceStatus": { +"description": "Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717. This must be accepted when ingesting UserData or MobileData. This field is not required for Partner Match User list.", "enum": [ -"MATCH_RATE_RANGE_UNKNOWN", -"MATCH_RATE_RANGE_NOT_ELIGIBLE", -"MATCH_RATE_RANGE_LESS_THAN_20", -"MATCH_RATE_RANGE_20_TO_30", -"MATCH_RATE_RANGE_31_TO_40", -"MATCH_RATE_RANGE_41_TO_50", -"MATCH_RATE_RANGE_51_TO_60", -"MATCH_RATE_RANGE_61_TO_70", -"MATCH_RATE_RANGE_71_TO_80", -"MATCH_RATE_RANGE_81_TO_90", -"MATCH_RATE_RANGE_91_TO_100" +"TERMS_OF_SERVICE_STATUS_UNSPECIFIED", +"ACCEPTED", +"REJECTED" ], "enumDescriptions": [ -"The match rate range is unknown.", -"The match rate range is not eligible.", -"The match rate range is less than 20% (in the interval `[0, 20)`).", -"The match rate range is between 20% and 30% (in the interval `[20, 31)`).", -"The match rate range is between 31% and 40% (in the interval `[31, 41)`).", -"The match rate range is between 41% and 50% (in the interval `[41, 51)`).", -"The match rate range is between 51% and 60% (in the interval `[51, 61)`.", -"The match rate range is between 61% and 70% (in the interval `[61, 71)`).", -"The match rate range is between 71% and 80% (in the interval `[71, 81)`).", -"The match rate range is between 81% and 90% (in the interval `[81, 91)`).", -"The match rate range is between 91% and 100% (in the interval `[91, 100]`)." +"Not specified.", +"Status indicating the caller has chosen to accept the terms of service.", +"Status indicating the caller has chosen to reject the terms of service." ], "type": "string" -}, -"userIdentifierCount": { -"description": "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.", -"format": "int64", -"type": "string" } }, "type": "object" }, -"Item": { -"description": "Represents an item in the cart associated with the event.", -"id": "Item", +"UserData": { +"description": "Data that identifies the user. At least one identifier is required.", +"id": "UserData", "properties": { -"additionalItemParameters": { -"description": "Optional. A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.", +"userIdentifiers": { +"description": "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.", "items": { -"$ref": "ItemParameter" +"$ref": "UserIdentifier" }, "type": "array" +} }, -"itemId": { -"description": "Optional. A unique identifier to reference the item.", -"type": "string" +"type": "object" }, -"merchantProductId": { -"description": "Optional. The product ID within the Merchant Center account.", +"UserIdData": { +"description": "User id data holding the user id.", +"id": "UserIdData", +"properties": { +"userId": { +"description": "Required. A unique identifier for a user, as defined by the advertiser.", "type": "string" +} }, -"quantity": { -"description": "Optional. The number of this item associated with the event.", -"format": "int64", -"type": "string" +"type": "object" }, -"unitPrice": { -"description": "Optional. The unit price excluding tax, shipping, and any transaction level discounts.", -"format": "double", -"type": "number" +"UserIdInfo": { +"description": "Additional information when `USER_ID` is one of the `upload_key_types`.", +"id": "UserIdInfo", +"properties": { +"dataSourceType": { +"description": "Optional. Immutable. Source of the upload data.", +"enum": [ +"DATA_SOURCE_TYPE_UNSPECIFIED", +"DATA_SOURCE_TYPE_FIRST_PARTY", +"DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU", +"DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE", +"DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA" +], +"enumDescriptions": [ +"Not specified.", +"The uploaded data is first-party data.", +"The uploaded data is from a third-party credit bureau.", +"The uploaded data is from a third-party voter file.", +"The uploaded data is third party partner data." +], +"type": "string" } }, "type": "object" }, -"ItemParameter": { -"description": "A bucket of any [event parameters related to an item](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events) to be included within the event that were not already specified using other structured fields.", -"id": "ItemParameter", +"UserIdentifier": { +"description": "A single identifier for the user.", +"id": "UserIdentifier", "properties": { -"parameterName": { -"description": "Required. The name of the parameter to use.", +"address": { +"$ref": "AddressInfo", +"description": "The known components of a user's address. Holds a grouping of identifiers that are matched all at once." +}, +"emailAddress": { +"description": "Hashed email address using SHA-256 hash function after normalization.", "type": "string" }, -"value": { -"description": "Required. The string representation of the value of the parameter to set.", +"phoneNumber": { +"description": "Hashed phone number using SHA-256 hash function after normalization (E164 standard).", "type": "string" } }, "type": "object" }, -"MobileData": { -"description": "Mobile IDs for the audience. At least one mobile ID is required.", -"id": "MobileData", +"UserList": { +"description": "A user list resource.", +"id": "UserList", "properties": { -"mobileIds": { -"description": "Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 `mobileIds` can be provided in a single AudienceMember.", -"items": { +"accessReason": { +"description": "Output only. The reason this account has been granted access to the list.", +"enum": [ +"ACCESS_REASON_UNSPECIFIED", +"OWNED", +"SHARED", +"LICENSED", +"SUBSCRIBED", +"AFFILIATED" +], +"enumDescriptions": [ +"Not specified.", +"The resource is owned by the user.", +"The resource is shared to the user.", +"The resource is licensed to the user.", +"The user subscribed to the resource.", +"The resource is accessible to the user." +], +"readOnly": true, "type": "string" }, -"type": "array" -} +"accountAccessStatus": { +"description": "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`.", +"enum": [ +"ACCESS_STATUS_UNSPECIFIED", +"ENABLED", +"DISABLED" +], +"enumDescriptions": [ +"Not specified.", +"The access is enabled.", +"The access is disabled." +], +"type": "string" }, -"type": "object" +"closingReason": { +"description": "Output only. The reason why this user list membership status is closed.", +"enum": [ +"CLOSING_REASON_UNSPECIFIED", +"UNUSED" +], +"enumDescriptions": [ +"Not specified.", +"The user list was closed because it has not been used in targeting recently. See https://support.google.com/google-ads/answer/2472738 for details." +], +"readOnly": true, +"type": "string" }, -"PairData": { -"description": "[PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience. At least one PAIR ID is required.", -"id": "PairData", -"properties": { -"pairIds": { -"description": "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.", -"items": { +"description": { +"description": "Optional. A description of the user list.", "type": "string" }, -"type": "array" -} +"displayName": { +"description": "Required. The display name of the user list.", +"type": "string" }, -"type": "object" +"id": { +"description": "Output only. The unique ID of the user list.", +"format": "int64", +"readOnly": true, +"type": "string" }, -"ProductAccount": { -"description": "Represents a specific account.", -"id": "ProductAccount", -"properties": { -"accountId": { -"description": "Required. The ID of the account. For example, your Google Ads account ID.", +"ingestedUserListInfo": { +"$ref": "IngestedUserListInfo", +"description": "Optional. Represents a user list that is populated by user ingested data." +}, +"integrationCode": { +"description": "Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.", "type": "string" }, -"accountType": { -"description": "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.", +"membershipDuration": { +"description": "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.", +"format": "google-duration", +"type": "string" +}, +"membershipStatus": { +"description": "Optional. Membership status of this user list.", "enum": [ -"ACCOUNT_TYPE_UNSPECIFIED", -"GOOGLE_ADS", -"DISPLAY_VIDEO_PARTNER", -"DISPLAY_VIDEO_ADVERTISER", -"DATA_PARTNER", -"GOOGLE_ANALYTICS_PROPERTY" +"MEMBERSHIP_STATUS_UNSPECIFIED", +"OPEN", +"CLOSED" ], "enumDescriptions": [ -"Unspecified product. Should never be used.", -"Google Ads.", -"Display & Video 360 partner.", -"Display & Video 360 advertiser.", -"Data Partner.", -"Google Analytics." +"Not specified.", +"Open status - User list is accruing members and can be targeted to.", +"Closed status - No new members being added." ], "type": "string" }, -"product": { -"deprecated": true, -"description": "Deprecated. Use `account_type` instead.", +"name": { +"description": "Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}", +"type": "string" +}, +"readOnly": { +"description": "Output only. An option that indicates if a user may edit a list.", +"readOnly": true, +"type": "boolean" +}, +"sizeInfo": { +"$ref": "SizeInfo", +"description": "Output only. Estimated number of members in this user list in different target networks.", +"readOnly": true +}, +"targetNetworkInfo": { +"$ref": "TargetNetworkInfo", +"description": "Optional. Eligibility information for different target networks." +} +}, +"type": "object" +}, +"UserListDirectLicense": { +"description": "A user list direct license. This feature is only available to data partners.", +"id": "UserListDirectLicense", +"properties": { +"clientAccountDisplayName": { +"description": "Output only. Name of client customer which the user list is being licensed to. This field is read-only.", +"readOnly": true, +"type": "string" +}, +"clientAccountId": { +"description": "Immutable. ID of client customer which the user list is being licensed to.", +"format": "int64", +"type": "string" +}, +"clientAccountType": { +"description": "Immutable. Account type of client customer which the user list is being licensed to.", "enum": [ -"PRODUCT_UNSPECIFIED", -"GOOGLE_ADS", -"DISPLAY_VIDEO_PARTNER", -"DISPLAY_VIDEO_ADVERTISER", -"DATA_PARTNER" +"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN", +"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS", +"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER", +"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER", +"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK" ], "enumDescriptions": [ -"Unspecified product. Should never be used.", -"Google Ads.", +"Unknown.", +"Google Ads customer.", "Display & Video 360 partner.", "Display & Video 360 advertiser.", -"Data Partner." +"Google Ad Manager audience link." ], "type": "string" -} -}, -"type": "object" }, -"RemoveAudienceMembersRequest": { -"description": "Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse.", -"id": "RemoveAudienceMembersRequest", -"properties": { -"audienceMembers": { -"description": "Required. The list of users to remove.", +"historicalPricings": { +"description": "Output only. Pricing history of this user list license. This field is read-only.", "items": { -"$ref": "AudienceMember" +"$ref": "UserListLicensePricing" }, +"readOnly": true, "type": "array" }, -"destinations": { -"description": "Required. The list of destinations to remove the users from.", -"items": { -"$ref": "Destination" +"metrics": { +"$ref": "UserListLicenseMetrics", +"description": "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", +"readOnly": true }, -"type": "array" +"name": { +"description": "Identifier. The resource name of the user list direct license.", +"type": "string" }, -"encoding": { -"description": "Optional. Required for UserData uploads. The encoding type of the user identifiers. Applies to only the outer encoding for encrypted user identifiers. For non `UserData` uploads, this field is ignored.", +"pricing": { +"$ref": "UserListLicensePricing", +"description": "Optional. UserListDirectLicense pricing." +}, +"status": { +"description": "Optional. Status of UserListDirectLicense - ENABLED or DISABLED.", "enum": [ -"ENCODING_UNSPECIFIED", -"HEX", -"BASE64" +"USER_LIST_LICENSE_STATUS_UNSPECIFIED", +"USER_LIST_LICENSE_STATUS_ENABLED", +"USER_LIST_LICENSE_STATUS_DISABLED" ], "enumDescriptions": [ -"Unspecified Encoding type. Should never be used.", -"Hex encoding.", -"Base 64 encoding." +"Unknown.", +"Active status - user list is still being licensed.", +"Inactive status - user list is no longer being licensed." ], "type": "string" }, -"encryptionInfo": { -"$ref": "EncryptionInfo", -"description": "Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored." -}, -"validateOnly": { -"description": "Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.", -"type": "boolean" -} -}, -"type": "object" +"userListDisplayName": { +"description": "Output only. Name of the user list being licensed. This field is read-only.", +"readOnly": true, +"type": "string" }, -"RemoveAudienceMembersResponse": { -"description": "Response from the RemoveAudienceMembersRequest.", -"id": "RemoveAudienceMembersResponse", -"properties": { -"requestId": { -"description": "The auto-generated ID of the request.", +"userListId": { +"description": "Immutable. ID of the user list being licensed.", +"format": "int64", "type": "string" } }, "type": "object" }, -"RemoveAudienceMembersStatus": { -"description": "The status of the remove audience members request.", -"id": "RemoveAudienceMembersStatus", +"UserListGlobalLicense": { +"description": "A user list global license. This feature is only available to data partners.", +"id": "UserListGlobalLicense", "properties": { -"mobileDataRemovalStatus": { -"$ref": "RemoveMobileDataStatus", -"description": "The status of the mobile data removal from the destination." +"historicalPricings": { +"description": "Output only. Pricing history of this user list license. This field is read-only.", +"items": { +"$ref": "UserListLicensePricing" }, -"pairDataRemovalStatus": { -"$ref": "RemovePairDataStatus", -"description": "The status of the pair data removal from the destination." +"readOnly": true, +"type": "array" }, -"userDataRemovalStatus": { -"$ref": "RemoveUserDataStatus", -"description": "The status of the user data removal from the destination." -} +"licenseType": { +"description": "Immutable. Product type of client customer which the user list is being licensed to.", +"enum": [ +"USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED", +"USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER", +"USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE", +"USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE" +], +"enumDescriptions": [ +"UNSPECIFIED.", +"Reseller license.", +"DataMart Sell Side license.", +"DataMart Buy Side license." +], +"type": "string" }, -"type": "object" +"metrics": { +"$ref": "UserListLicenseMetrics", +"description": "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", +"readOnly": true }, -"RemoveMobileDataStatus": { -"description": "The status of the mobile data removal from the destination.", -"id": "RemoveMobileDataStatus", -"properties": { -"mobileIdCount": { -"description": "The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not.", -"format": "int64", +"name": { +"description": "Identifier. The resource name of the user list global license.", "type": "string" }, -"recordCount": { -"description": "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.", -"format": "int64", -"type": "string" -} +"pricing": { +"$ref": "UserListLicensePricing", +"description": "Optional. UserListGlobalLicense pricing." }, -"type": "object" +"status": { +"description": "Optional. Status of UserListGlobalLicense - ENABLED or DISABLED.", +"enum": [ +"USER_LIST_LICENSE_STATUS_UNSPECIFIED", +"USER_LIST_LICENSE_STATUS_ENABLED", +"USER_LIST_LICENSE_STATUS_DISABLED" +], +"enumDescriptions": [ +"Unknown.", +"Active status - user list is still being licensed.", +"Inactive status - user list is no longer being licensed." +], +"type": "string" }, -"RemovePairDataStatus": { -"description": "The status of the pair data removal from the destination.", -"id": "RemovePairDataStatus", -"properties": { -"pairIdCount": { -"description": "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.", -"format": "int64", +"userListDisplayName": { +"description": "Output only. Name of the user list being licensed. This field is read-only.", +"readOnly": true, "type": "string" }, -"recordCount": { -"description": "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.", +"userListId": { +"description": "Immutable. ID of the user list being licensed.", "format": "int64", "type": "string" } }, "type": "object" }, -"RemoveUserDataStatus": { -"description": "The status of the user data removal from the destination.", -"id": "RemoveUserDataStatus", +"UserListGlobalLicenseCustomerInfo": { +"description": "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.", +"id": "UserListGlobalLicenseCustomerInfo", "properties": { -"recordCount": { -"description": "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.", -"format": "int64", +"clientAccountDisplayName": { +"description": "Output only. Name of client customer which the user list is being licensed to.", +"readOnly": true, "type": "string" }, -"userIdentifierCount": { -"description": "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.", +"clientAccountId": { +"description": "Output only. ID of client customer which the user list is being licensed to.", "format": "int64", +"readOnly": true, "type": "string" -} }, -"type": "object" +"clientAccountType": { +"description": "Output only. Product type of client customer which the user list is being licensed to.", +"enum": [ +"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN", +"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS", +"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER", +"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER", +"USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK" +], +"enumDescriptions": [ +"Unknown.", +"Google Ads customer.", +"Display & Video 360 partner.", +"Display & Video 360 advertiser.", +"Google Ad Manager audience link." +], +"readOnly": true, +"type": "string" }, -"RequestStatusPerDestination": { -"description": "A request status per destination.", -"id": "RequestStatusPerDestination", -"properties": { -"audienceMembersIngestionStatus": { -"$ref": "IngestAudienceMembersStatus", -"description": "The status of the ingest audience members request." +"historicalPricings": { +"description": "Output only. Pricing history of this user list license.", +"items": { +"$ref": "UserListLicensePricing" }, -"audienceMembersRemovalStatus": { -"$ref": "RemoveAudienceMembersStatus", -"description": "The status of the remove audience members request." +"readOnly": true, +"type": "array" }, -"destination": { -"$ref": "Destination", -"description": "A destination within a DM API request." +"licenseType": { +"description": "Output only. Product type of client customer which the user list is being licensed to.", +"enum": [ +"USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED", +"USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER", +"USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE", +"USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE" +], +"enumDescriptions": [ +"UNSPECIFIED.", +"Reseller license.", +"DataMart Sell Side license.", +"DataMart Buy Side license." +], +"readOnly": true, +"type": "string" }, -"errorInfo": { -"$ref": "ErrorInfo", -"description": "An error info error containing the error reason and error counts related to the upload." +"metrics": { +"$ref": "UserListLicenseMetrics", +"description": "Output only. Metrics related to this license This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call.", +"readOnly": true }, -"eventsIngestionStatus": { -"$ref": "IngestEventsStatus", -"description": "The status of the ingest events request." +"name": { +"description": "Identifier. The resource name of the user list global license customer.", +"type": "string" }, -"requestStatus": { -"description": "The request status of the destination.", +"pricing": { +"$ref": "UserListLicensePricing", +"description": "Output only. UserListDirectLicense pricing.", +"readOnly": true +}, +"status": { +"description": "Output only. Status of UserListDirectLicense - ENABLED or DISABLED.", "enum": [ -"REQUEST_STATUS_UNKNOWN", -"SUCCESS", -"PROCESSING", -"FAILED", -"PARTIAL_SUCCESS" +"USER_LIST_LICENSE_STATUS_UNSPECIFIED", +"USER_LIST_LICENSE_STATUS_ENABLED", +"USER_LIST_LICENSE_STATUS_DISABLED" ], "enumDescriptions": [ -"The request status is unknown.", -"The request succeeded.", -"The request is processing.", -"The request failed.", -"The request partially succeeded." +"Unknown.", +"Active status - user list is still being licensed.", +"Inactive status - user list is no longer being licensed." ], +"readOnly": true, "type": "string" }, -"warningInfo": { -"$ref": "WarningInfo", -"description": "A warning info containing the warning reason and warning counts related to the upload." -} -}, -"type": "object" -}, -"RetrieveRequestStatusResponse": { -"description": "Response from the RetrieveRequestStatusRequest.", -"id": "RetrieveRequestStatusResponse", -"properties": { -"requestStatusPerDestination": { -"description": "A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request.", -"items": { -"$ref": "RequestStatusPerDestination" +"userListDisplayName": { +"description": "Output only. Name of the user list being licensed.", +"readOnly": true, +"type": "string" }, -"type": "array" +"userListId": { +"description": "Output only. ID of the user list being licensed.", +"format": "int64", +"readOnly": true, +"type": "string" } }, "type": "object" }, -"Status": { -"description": "The `Status` type defines a logical error model that is suitable for 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).", -"id": "Status", +"UserListLicenseMetrics": { +"description": "Metrics related to a user list license.", +"id": "UserListLicenseMetrics", "properties": { -"code": { -"description": "The status code, which should be an enum value of google.rpc.Code.", -"format": "int32", -"type": "integer" +"clickCount": { +"description": "Output only. The number of clicks for the user list license.", +"format": "int64", +"readOnly": true, +"type": "string" }, -"details": { -"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", -"items": { -"additionalProperties": { -"description": "Properties of the object. Contains field @type with type URL.", -"type": "any" +"endDate": { +"description": "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.", +"format": "int64", +"readOnly": true, +"type": "string" }, -"type": "object" +"impressionCount": { +"description": "Output only. The number of impressions for the user list license.", +"format": "int64", +"readOnly": true, +"type": "string" }, -"type": "array" +"revenueUsdMicros": { +"description": "Output only. The revenue for the user list license in USD micros.", +"format": "int64", +"readOnly": true, +"type": "string" }, -"message": { -"description": "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.", +"startDate": { +"description": "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.", +"format": "int64", +"readOnly": true, "type": "string" } }, "type": "object" }, -"TermsOfService": { -"description": "The terms of service that the user has accepted/rejected.", -"id": "TermsOfService", +"UserListLicensePricing": { +"description": "A user list license pricing.", +"id": "UserListLicensePricing", "properties": { -"customerMatchTermsOfServiceStatus": { -"description": "Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717. This must be accepted when ingesting UserData or MobileData. This field is not required for Partner Match User list.", +"buyerApprovalState": { +"description": "Output only. The buyer approval state of this pricing. This field is read-only.", "enum": [ -"TERMS_OF_SERVICE_STATUS_UNSPECIFIED", -"ACCEPTED", +"USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED", +"PENDING", +"APPROVED", "REJECTED" ], "enumDescriptions": [ -"Not specified.", -"Status indicating the caller has chosen to accept the terms of service.", -"Status indicating the caller has chosen to reject the terms of service." +"UNSPECIFIED.", +"User list client has not yet accepted the pricing terms set by the user list owner.", +"User list client has accepted the pricing terms set by the user list owner.", +"User list client has rejected the pricing terms set by the user list owner." ], +"readOnly": true, "type": "string" -} }, -"type": "object" +"costMicros": { +"description": "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`.", +"format": "int64", +"type": "string" }, -"UserData": { -"description": "Data that identifies the user. At least one identifier is required.", -"id": "UserData", -"properties": { -"userIdentifiers": { -"description": "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.", -"items": { -"$ref": "UserIdentifier" +"costType": { +"description": "Immutable. The cost type of this pricing. Can be set only in the `create` operation. Can't be updated for an existing license.", +"enum": [ +"USER_LIST_PRICING_COST_TYPE_UNSPECIFIED", +"CPC", +"CPM", +"MEDIA_SHARE" +], +"enumDescriptions": [ +"Unspecified.", +"Cost per click.", +"Cost per mille (thousand impressions).", +"Media share." +], +"type": "string" }, -"type": "array" -} +"currencyCode": { +"description": "Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.", +"type": "string" }, -"type": "object" +"endTime": { +"description": "Optional. End time of the pricing.", +"format": "google-datetime", +"type": "string" }, -"UserIdentifier": { -"description": "A single identifier for the user.", -"id": "UserIdentifier", -"properties": { -"address": { -"$ref": "AddressInfo", -"description": "The known components of a user's address. Holds a grouping of identifiers that are matched all at once." +"maxCostMicros": { +"description": "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.", +"format": "int64", +"type": "string" }, -"emailAddress": { -"description": "Hashed email address using SHA-256 hash function after normalization.", +"pricingActive": { +"description": "Output only. Whether this pricing is active.", +"readOnly": true, +"type": "boolean" +}, +"pricingId": { +"description": "Output only. The ID of this pricing.", +"format": "int64", +"readOnly": true, "type": "string" }, -"phoneNumber": { -"description": "Hashed phone number using SHA-256 hash function after normalization (E164 standard).", +"startTime": { +"description": "Output only. Start time of the pricing.", +"format": "google-datetime", +"readOnly": true, "type": "string" } }, From c18e222aa0eeab937f78b2be0719c031e1686fbb Mon Sep 17 00:00:00 2001 From: Yoshi AutomationDate: Tue, 24 Feb 2026 07:27:56 +0000 Subject: [PATCH 09/29] feat(dataplex): update the api #### dataplex:v1 The following keys were added: - resources.projects.resources.locations.methods.lookupEntryLinks (Total Keys: 23) - schemas.GoogleCloudDataplexV1DataQualityRule.properties.debugQueries (Total Keys: 2) - schemas.GoogleCloudDataplexV1DataQualityRuleDebugQuery (Total Keys: 3) - schemas.GoogleCloudDataplexV1DataQualityRuleResult.properties.debugQueriesResultSets (Total Keys: 3) - schemas.GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResult (Total Keys: 10) - schemas.GoogleCloudDataplexV1LookupEntryLinksResponse (Total Keys: 5) --- ...aplex_v1.projects.locations.dataScans.html | 121 +++++++++++++++ ..._v1.projects.locations.dataScans.jobs.html | 52 +++++++ docs/dyn/dataplex_v1.projects.locations.html | 63 ++++++++ .../documents/dataplex.v1.json | 146 +++++++++++++++++- 4 files changed, 381 insertions(+), 1 deletion(-) diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index 1c65b1b25f3..1a0c368a0c0 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 1838f758d07..d8a0908535e 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 12230093ce4..92448e990d3 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. ++
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/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json
index e9c5293adea..5a534eed2a9 100644
--- a/googleapiclient/discovery_cache/documents/dataplex.v1.json
+++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json
@@ -884,6 +884,68 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
+"lookupEntryLinks": {
+"description": "Looks up Entry Links referencing the specified Entry.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupEntryLinks",
+"httpMethod": "GET",
+"id": "dataplex.projects.locations.lookupEntryLinks",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"entry": {
+"description": "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.",
+"location": "query",
+"type": "string"
+},
+"entryLinkTypes": {
+"description": "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.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"entryMode": {
+"description": "Mode of entry reference.",
+"enum": [
+"ENTRY_MODE_UNSPECIFIED",
+"SOURCE",
+"TARGET"
+],
+"enumDescriptions": [
+"Unspecified entry mode. Returns both directional and non-directional entry links which references the entry.",
+"Returns all directed entry links which references the entry as source.",
+"Return all directed entry links which references the entry as target."
+],
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The project to which the request should be attributed to Format: projects/{project_id_or_number}/locations/{location_id}.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "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.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "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.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:lookupEntryLinks",
+"response": {
+"$ref": "GoogleCloudDataplexV1LookupEntryLinksResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
"searchEntries": {
"description": "Searches for Entries matching the given query and scope.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchEntries",
@@ -7869,7 +7931,7 @@
}
}
},
-"revision": "20260203",
+"revision": "20260213",
"rootUrl": "https://dataplex.googleapis.com/",
"schemas": {
"Empty": {
@@ -10114,6 +10176,13 @@
"description": "Optional. The unnested column which this rule is evaluated against.",
"type": "string"
},
+"debugQueries": {
+"description": "Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future.",
+"items": {
+"$ref": "GoogleCloudDataplexV1DataQualityRuleDebugQuery"
+},
+"type": "array"
+},
"description": {
"description": "Optional. Description of the rule. The maximum length is 1,024 characters.",
"type": "string"
@@ -10178,6 +10247,21 @@
},
"type": "object"
},
+"GoogleCloudDataplexV1DataQualityRuleDebugQuery": {
+"description": "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()}",
+"id": "GoogleCloudDataplexV1DataQualityRuleDebugQuery",
+"properties": {
+"description": {
+"description": "Optional. Specifies the description of the debug query. The maximum length is 1,024 characters.",
+"type": "string"
+},
+"sqlStatement": {
+"description": "Required. Specifies the SQL statement to be executed.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDataplexV1DataQualityRuleNonNullExpectation": {
"description": "Evaluates whether each column value is null.",
"id": "GoogleCloudDataplexV1DataQualityRuleNonNullExpectation",
@@ -10228,6 +10312,14 @@
"readOnly": true,
"type": "string"
},
+"debugQueriesResultSets": {
+"description": "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.",
+"items": {
+"$ref": "GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResultSet"
+},
+"readOnly": true,
+"type": "array"
+},
"evaluatedCount": {
"description": "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.",
"format": "int64",
@@ -10270,6 +10362,40 @@
},
"type": "object"
},
+"GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResult": {
+"description": "Contains a single result from the debug query.",
+"id": "GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResult",
+"properties": {
+"name": {
+"description": "Specifies the name of the result. Available if provided with an explicit alias using [AS] alias.",
+"type": "string"
+},
+"type": {
+"description": "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).",
+"type": "string"
+},
+"value": {
+"description": "Represents the value of the result as a string.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResultSet": {
+"description": "Contains all results from a debug query.",
+"id": "GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResultSet",
+"properties": {
+"results": {
+"description": "Output only. Contains all results. Up to 10 results can be returned.",
+"items": {
+"$ref": "GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResult"
+},
+"readOnly": true,
+"type": "array"
+}
+},
+"type": "object"
+},
"GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation": {
"description": "Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10",
"id": "GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation",
@@ -13458,6 +13584,24 @@
},
"type": "object"
},
+"GoogleCloudDataplexV1LookupEntryLinksResponse": {
+"description": "Response message for LookupEntryLinks.",
+"id": "GoogleCloudDataplexV1LookupEntryLinksResponse",
+"properties": {
+"entryLinks": {
+"description": "List of entry links that reference the specified entry.",
+"items": {
+"$ref": "GoogleCloudDataplexV1EntryLink"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.",
+"type": "string"
+}
+},
+"type": "object"
+},
"GoogleCloudDataplexV1MetadataFeed": {
"description": "MetadataFeed contains information related to the metadata feed.",
"id": "GoogleCloudDataplexV1MetadataFeed",
From 11228ab21add546a6783e1f49b75d0a19163daf8 Mon Sep 17 00:00:00 2001
From: Yoshi Automation
Date: Tue, 24 Feb 2026 07:27:56 +0000
Subject: [PATCH 10/29] feat(dialogflow): update the api
#### dialogflow:v2beta1
The following keys were added:
- schemas.GoogleCloudDialogflowV2beta1ConversationProfile.properties.useBidiStreaming.type (Total Keys: 1)
---
.../dialogflow_v2beta1.projects.conversationProfiles.html | 6 ++++++
...low_v2beta1.projects.locations.conversationProfiles.html | 6 ++++++
.../dialogflow_v2beta1.projects.locations.suggestions.html | 1 +
docs/dyn/dialogflow_v2beta1.projects.suggestions.html | 1 +
.../discovery_cache/documents/dialogflow.v2beta1.json | 5 ++++-
5 files changed, 18 insertions(+), 1 deletion(-)
diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html
index 36fefd4cd37..36366d41ae4 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,
}
+ 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"
+}
+