sandbox/alpha-scone-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
iterable_item_added
root['schemas']['CustomerSupportContentContactFlowModel']['properties']['contactFlowType']['enum'][13]MOSP
root['schemas']['CustomerSupportContentContactFlowModel']['properties']['contactFlowType']['enumDescriptions'][13]Submission via MOSP.
root['schemas']['CustomerSupportContentContactForm']['properties']['connectorType']['enum'][13]MOSP
root['schemas']['CustomerSupportContentContactForm']['properties']['connectorType']['enumDescriptions'][13]Submission via MOSP.
sandbox/alpha-scone-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
iterable_item_added
root['schemas']['CustomerSupportContentContactFlowModel']['properties']['contactFlowType']['enum'][13]MOSP
root['schemas']['CustomerSupportContentContactFlowModel']['properties']['contactFlowType']['enumDescriptions'][13]Submission via MOSP.
root['schemas']['CustomerSupportContentContactForm']['properties']['connectorType']['enum'][13]MOSP
root['schemas']['CustomerSupportContentContactForm']['properties']['connectorType']['enumDescriptions'][13]Submission via MOSP.
sandbox/alpha-tasks-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/alpha-tasks-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250216
sandbox/autopush-analyticssuitefrontend-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-analyticssuitefrontend-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-apigateway-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-apigateway-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-apigateway-v1alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-apigateway-v1alpha2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-apigateway-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-apigee-
dictionary_item_added
  • root['schemas']['GoogleCloudApigeeV1Deployment']['description']
values_changed
root['resources']['organizations']['resources']['apiproducts']['methods']['attributes']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}`
root['resources']['organizations']['resources']['apiproducts']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['list']['description']
new_valueLists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.
root['resources']['organizations']['resources']['apiproducts']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the organization. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization. Use the following structure in your request: `organizations/{org}`
root['resources']['organizations']['resources']['apiproducts']['methods']['update']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path.To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['updateApiProductAttribute']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['delete']['parameters']['name']['description']
new_valueRequired. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization. If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization.
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['update']['parameters']['name']['description']
new_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apis']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the organization in the following format: `organizations/{org}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in the following format: `organizations/{org}`
root['resources']['organizations']['resources']['apis']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['methods']['list']['description']
new_valueLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.
root['resources']['organizations']['resources']['apis']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the organization in the following format: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in the following format: `organizations/{org}`
root['resources']['organizations']['resources']['apis']['methods']['patch']['parameters']['name']['description']
new_valueRequired. API proxy to update in the following format: `organizations/{org}/apis/{api}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy to update in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['delete']['parameters']['name']['description']
new_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['get']['parameters']['name']['description']
new_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['updateApiProxyRevision']['parameters']['name']['description']
new_valueRequired. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['deploy']['parameters']['name']['description']
new_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['getDeployments']['parameters']['name']['description']
new_valueRequired. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['undeploy']['parameters']['name']['description']
new_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['create']['parameters']['parent']['description']
new_valueRequired. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['deleteData']['parameters']['name']['description']
new_valueRequired. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['list']['parameters']['parent']['description']
new_valueRequired. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['resources']['data']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['deployments']['methods']['generateDeployChangeReport']['parameters']['name']['description']
new_valueName of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueName of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['deploy']['parameters']['name']['description']
new_valueRequired. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['getDeployments']['parameters']['name']['description']
new_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['undeploy']['parameters']['name']['description']
new_valueRequired. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['sharedflows']['methods']['create']['parameters']['parent']['description']
new_valueRequired. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['delete']['parameters']['name']['description']
new_valueRequired. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['list']['description']
new_valueLists all shared flows in the organization. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists all shared flows in the organization.
root['resources']['organizations']['resources']['sharedflows']['methods']['list']['parameters']['parent']['description']
new_valueRequired. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['delete']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['updateSharedFlowRevision']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`. If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`.
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-apigee-v1
dictionary_item_added
  • root['schemas']['GoogleCloudApigeeV1Deployment']['description']
values_changed
root['resources']['organizations']['resources']['apiproducts']['methods']['attributes']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}`
root['resources']['organizations']['resources']['apiproducts']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['list']['description']
new_valueLists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.
root['resources']['organizations']['resources']['apiproducts']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the organization. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization. Use the following structure in your request: `organizations/{org}`
root['resources']['organizations']['resources']['apiproducts']['methods']['update']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path.To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['updateApiProductAttribute']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['delete']['parameters']['name']['description']
new_valueRequired. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization. If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization.
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['update']['parameters']['name']['description']
new_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apis']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the organization in the following format: `organizations/{org}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in the following format: `organizations/{org}`
root['resources']['organizations']['resources']['apis']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['methods']['list']['description']
new_valueLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.
root['resources']['organizations']['resources']['apis']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the organization in the following format: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in the following format: `organizations/{org}`
root['resources']['organizations']['resources']['apis']['methods']['patch']['parameters']['name']['description']
new_valueRequired. API proxy to update in the following format: `organizations/{org}/apis/{api}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy to update in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['delete']['parameters']['name']['description']
new_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['get']['parameters']['name']['description']
new_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['updateApiProxyRevision']['parameters']['name']['description']
new_valueRequired. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['deploy']['parameters']['name']['description']
new_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['getDeployments']['parameters']['name']['description']
new_valueRequired. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['undeploy']['parameters']['name']['description']
new_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['create']['parameters']['parent']['description']
new_valueRequired. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['deleteData']['parameters']['name']['description']
new_valueRequired. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['list']['parameters']['parent']['description']
new_valueRequired. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['resources']['data']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['deployments']['methods']['generateDeployChangeReport']['parameters']['name']['description']
new_valueName of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueName of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['deploy']['parameters']['name']['description']
new_valueRequired. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['getDeployments']['parameters']['name']['description']
new_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['undeploy']['parameters']['name']['description']
new_valueRequired. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['sharedflows']['methods']['create']['parameters']['parent']['description']
new_valueRequired. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['delete']['parameters']['name']['description']
new_valueRequired. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['list']['description']
new_valueLists all shared flows in the organization. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists all shared flows in the organization.
root['resources']['organizations']['resources']['sharedflows']['methods']['list']['parameters']['parent']['description']
new_valueRequired. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['delete']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['updateSharedFlowRevision']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`. If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`.
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-appsbackup-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-appsbackup-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-appsgenaiserver-pa-
dictionary_item_added
  • root['schemas']['AppsIntelligenceGenAiHelpMeOrganizeUseCaseParams']
  • root['schemas']['AppsIntelligenceGenAiStructuredParagraph']
  • root['schemas']['AppsIntelligenceGenAiStructuredContentNode']['properties']['paragraph']
  • root['schemas']['AppsIntelligenceGenAiUseCaseParams']['properties']['helpMeOrganizeUseCaseParams']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['AppsIntelligenceGenAiStructuredContentNode']['description']
new_valueStructuredContentNode represents a node in the AST (internal or root). Example: text: "Here are some dog breeds: Dogs are great!" root { container { plain_text: "Here are some dog breeds: Dogs are great!" children { plain_text: "Here are some dog breeds: " } children { plain_text: " " table { metadata {...} columns {...} } } children { plain_text: " Dogs are great!" } } } Next ID: 43.
old_valueStructuredContentNode represents a node in the AST (internal or root). Example: text: "Here are some dog breeds: Dogs are great!" root { container { plain_text: "Here are some dog breeds: Dogs are great!" children { plain_text: "Here are some dog breeds: " } children { plain_text: " " table { metadata {...} columns {...} } } children { plain_text: " Dogs are great!" } } } Next ID: 42.
root['schemas']['AppsIntelligenceGenAiUseCaseParams']['description']
new_valueGenerate Use Case specific parameters Next ID: 12.
old_valueGenerate Use Case specific parameters Next ID: 11.
iterable_item_added
root['schemas']['AppsExtensionsDuetAiActionStaticPlanData']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsExtensionsDuetAiActionStaticPlanData']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiClientDebugInfo']['properties']['useCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiClientDebugInfo']['properties']['useCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiDataCollectionRequest']['properties']['entryPoint']['enum'][43]ENTRY_POINT_COMMENTS
root['schemas']['AppsIntelligenceGenAiGenerateRequest']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiGenerateRequest']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiGenerateStatusResponse']['properties']['status']['enum'][26]STATUS_ALS_STATE_GENERATING_IMAGES
root['schemas']['AppsIntelligenceGenAiGenerateStatusResponse']['properties']['status']['enum'][27]STATUS_GEMKICK_RESPONSE_GENERATOR_GENERATING
root['schemas']['AppsIntelligenceGenAiGenerateStatusResponse']['properties']['status']['enumDescriptions'][26]Status when an image generation starts.
root['schemas']['AppsIntelligenceGenAiGenerateStatusResponse']['properties']['status']['enumDescriptions'][27]Status when the response generator is generating the response.
root['schemas']['AppsIntelligenceGenAiGenerationIteration']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiGenerationIteration']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiGetQuotaSummaryRequest']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiGetQuotaSummaryRequest']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiQuestionAnswerListActionParamsQuestionAnswer']['properties']['useCaseForSuggestionFollowup']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiQuestionAnswerListActionParamsQuestionAnswer']['properties']['useCaseForSuggestionFollowup']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiRecordFeatureUsageRequest']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiRecordFeatureUsageRequest']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiStarterTile']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiStarterTile']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiTurn']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiTurn']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiWriteAuditLogRequest']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiWriteAuditLogRequest']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][216]GEMKICK_GMAIL_PEP_FLYOUT
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][427]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][437]PMAX_GWS_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][491]SEM_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][216]GEMKICK_GMAIL_PEP_FLYOUT
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][427]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][437]PMAX_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][491]SEM_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][80]COMPLIANCE_ACCESS_APPROVALS_AC_SELF_SERVE
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][89]COMPLIANCE_CLIENT_SIDE_ENCRYPTION_AC_SELF_SERVE
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][99]COMPLIANCE_DATA_REGIONS_AC_SELF_SERVE
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][216]GEMKICK_GMAIL_PEP_FLYOUT
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][427]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][437]PMAX_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][491]SEM_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][80]COMPLIANCE_ACCESS_APPROVALS_AC_SELF_SERVE
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][89]COMPLIANCE_CLIENT_SIDE_ENCRYPTION_AC_SELF_SERVE
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][99]COMPLIANCE_DATA_REGIONS_AC_SELF_SERVE
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][216]GEMKICK_GMAIL_PEP_FLYOUT
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][427]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][437]PMAX_GWS_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][491]SEM_GEMINI_G1_SL_GEOVN
sandbox/autopush-appsgenaiserver-pa-v1
dictionary_item_added
  • root['schemas']['AppsIntelligenceGenAiHelpMeOrganizeUseCaseParams']
  • root['schemas']['AppsIntelligenceGenAiStructuredParagraph']
  • root['schemas']['AppsIntelligenceGenAiStructuredContentNode']['properties']['paragraph']
  • root['schemas']['AppsIntelligenceGenAiUseCaseParams']['properties']['helpMeOrganizeUseCaseParams']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['AppsIntelligenceGenAiStructuredContentNode']['description']
new_valueStructuredContentNode represents a node in the AST (internal or root). Example: text: "Here are some dog breeds: Dogs are great!" root { container { plain_text: "Here are some dog breeds: Dogs are great!" children { plain_text: "Here are some dog breeds: " } children { plain_text: " " table { metadata {...} columns {...} } } children { plain_text: " Dogs are great!" } } } Next ID: 43.
old_valueStructuredContentNode represents a node in the AST (internal or root). Example: text: "Here are some dog breeds: Dogs are great!" root { container { plain_text: "Here are some dog breeds: Dogs are great!" children { plain_text: "Here are some dog breeds: " } children { plain_text: " " table { metadata {...} columns {...} } } children { plain_text: " Dogs are great!" } } } Next ID: 42.
root['schemas']['AppsIntelligenceGenAiUseCaseParams']['description']
new_valueGenerate Use Case specific parameters Next ID: 12.
old_valueGenerate Use Case specific parameters Next ID: 11.
iterable_item_added
root['schemas']['AppsExtensionsDuetAiActionStaticPlanData']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsExtensionsDuetAiActionStaticPlanData']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiClientDebugInfo']['properties']['useCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiClientDebugInfo']['properties']['useCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiDataCollectionRequest']['properties']['entryPoint']['enum'][43]ENTRY_POINT_COMMENTS
root['schemas']['AppsIntelligenceGenAiGenerateRequest']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiGenerateRequest']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiGenerateStatusResponse']['properties']['status']['enum'][26]STATUS_ALS_STATE_GENERATING_IMAGES
root['schemas']['AppsIntelligenceGenAiGenerateStatusResponse']['properties']['status']['enum'][27]STATUS_GEMKICK_RESPONSE_GENERATOR_GENERATING
root['schemas']['AppsIntelligenceGenAiGenerateStatusResponse']['properties']['status']['enumDescriptions'][26]Status when an image generation starts.
root['schemas']['AppsIntelligenceGenAiGenerateStatusResponse']['properties']['status']['enumDescriptions'][27]Status when the response generator is generating the response.
root['schemas']['AppsIntelligenceGenAiGenerationIteration']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiGenerationIteration']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiGetQuotaSummaryRequest']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiGetQuotaSummaryRequest']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiQuestionAnswerListActionParamsQuestionAnswer']['properties']['useCaseForSuggestionFollowup']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiQuestionAnswerListActionParamsQuestionAnswer']['properties']['useCaseForSuggestionFollowup']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiRecordFeatureUsageRequest']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiRecordFeatureUsageRequest']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiStarterTile']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiStarterTile']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiTurn']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiTurn']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsIntelligenceGenAiWriteAuditLogRequest']['properties']['generateUseCase']['enum'][117]SEARCH_ANSWER
root['schemas']['AppsIntelligenceGenAiWriteAuditLogRequest']['properties']['generateUseCase']['enumDescriptions'][117]Use case for Search Answer.
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][216]GEMKICK_GMAIL_PEP_FLYOUT
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][427]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][437]PMAX_GWS_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][491]SEM_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][216]GEMKICK_GMAIL_PEP_FLYOUT
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][427]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][437]PMAX_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][491]SEM_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][80]COMPLIANCE_ACCESS_APPROVALS_AC_SELF_SERVE
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][89]COMPLIANCE_CLIENT_SIDE_ENCRYPTION_AC_SELF_SERVE
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][99]COMPLIANCE_DATA_REGIONS_AC_SELF_SERVE
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][216]GEMKICK_GMAIL_PEP_FLYOUT
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][427]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][437]PMAX_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][491]SEM_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][80]COMPLIANCE_ACCESS_APPROVALS_AC_SELF_SERVE
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][89]COMPLIANCE_CLIENT_SIDE_ENCRYPTION_AC_SELF_SERVE
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][99]COMPLIANCE_DATA_REGIONS_AC_SELF_SERVE
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][216]GEMKICK_GMAIL_PEP_FLYOUT
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][427]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][437]PMAX_GWS_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][491]SEM_GEMINI_G1_SL_GEOVN
sandbox/autopush-asia-east1-cloudbuild-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-asia-east1-cloudbuild-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-asia-east1-cloudbuild-v2
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-auditrecording-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
iterable_item_added
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][76]CROWDSOURCE_LOOKBOOK_GENERAL_VIDEO_DONATION_CONSENT
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][415]PAISA_MERCHANT_AADHAAR_CONSENT
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][76]An event specifying Crowdsource Lookbook General Video Donation task consent.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][415]Event specifying that the merchant has given consent for redirection to DigiLocker for Aadhaar/Udyam Aadhaar retrieval.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enum'][139]CROWDSOURCE_WEB_LOOKBOOK_GENERAL_VIDEO_DONATION_CONSENT_SCREEN
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enum'][698]PAISA_MERCHANT_FLUTTER_OOBE_AADHAAR_SCREEN
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][138]Crowdsource web Lookbook General Donation task consent screen.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][139]Crowdsource web Lookbook General Video Donation task consent screen.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][698]User going through the Paisa Merchant OOBE Aadhaar screen in flutter app.
sandbox/autopush-auditrecording-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
iterable_item_added
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][76]CROWDSOURCE_LOOKBOOK_GENERAL_VIDEO_DONATION_CONSENT
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enum'][415]PAISA_MERCHANT_AADHAAR_CONSENT
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][76]An event specifying Crowdsource Lookbook General Video Donation task consent.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodEvent']['properties']['name']['enumDescriptions'][415]Event specifying that the merchant has given consent for redirection to DigiLocker for Aadhaar/Udyam Aadhaar retrieval.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enum'][139]CROWDSOURCE_WEB_LOOKBOOK_GENERAL_VIDEO_DONATION_CONSENT_SCREEN
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enum'][698]PAISA_MERCHANT_FLUTTER_OOBE_AADHAAR_SCREEN
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][138]Crowdsource web Lookbook General Donation task consent screen.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][139]Crowdsource web Lookbook General Video Donation task consent screen.
root['schemas']['GoogleInternalApiAuditrecordingV1NongoogleprodUiContext']['properties']['contextId']['enumDescriptions'][698]User going through the Paisa Merchant OOBE Aadhaar screen in flutter app.
sandbox/autopush-automl-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-automl-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-automl-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-automl-v1p1beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-blobcomments-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-blobcomments-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-cloudaicompanion-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudaicompanion-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudaicompanion-v1alpha
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudaicompanion-v1beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudaicompanionadmin-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudaicompanionadmin-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudaicompanionadmin-v1alpha
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudaicompanionadmin-v1beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudbuild-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudbuild-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudbuild-v2
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-cloudchannel-
dictionary_item_added
  • root['resources']['opportunities']['methods']['get']['parameters']['partner']
  • root['resources']['opportunities']['methods']['patch']['parameters']['partner']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleCloudChannelV1alpha1QualificationInfo']['properties']['publicSector']['description']
new_valueOptional. Whether or not the customer is a public sector organization that requires competing offers from multiple vendors. Can't be edited after the Opportunity is Accepted. Default: false.
old_valueOptional. Whether or not the customer is a public sector organization that requires competing offers from multiple vendors. Can be edited after the Opportunity is Accepted. Default: false.
sandbox/autopush-cloudchannel-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudchannel-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudchannel-pa-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudchannel-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudchannel-v1alpha1
dictionary_item_added
  • root['resources']['opportunities']['methods']['get']['parameters']['partner']
  • root['resources']['opportunities']['methods']['patch']['parameters']['partner']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleCloudChannelV1alpha1QualificationInfo']['properties']['publicSector']['description']
new_valueOptional. Whether or not the customer is a public sector organization that requires competing offers from multiple vendors. Can't be edited after the Opportunity is Accepted. Default: false.
old_valueOptional. Whether or not the customer is a public sector organization that requires competing offers from multiple vendors. Can be edited after the Opportunity is Accepted. Default: false.
sandbox/autopush-cloudcommerceprocurement-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-cloudcommerceprocurement-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-cloudcrmipfrontend-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudcrmipfrontend-pa-v1
dictionary_item_removed
  • root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integrationRegion']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integration']['description']
new_valueRequired. Resource Name of the integration where template needs to be imported/inserted.
old_valueRequired. Name of the integration where template needs to be imported.
sandbox/autopush-cloudcrmipfrontend-pa-v1alpha
dictionary_item_removed
  • root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integrationRegion']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integration']['description']
new_valueRequired. Resource Name of the integration where template needs to be imported/inserted.
old_valueRequired. Name of the integration where template needs to be imported.
sandbox/autopush-cloudcrmipfrontend-pa-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudidentity-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudidentity-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudidentity-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudidentity-pa-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudidentity-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudidentity-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudprivatecatalog-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudprivatecatalog-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudprivatecatalog-v1alpha1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudprivatecatalog-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudprivatecatalogproducer-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudprivatecatalogproducer-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudprivatecatalogproducer-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudsupport-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudsupport-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudsupport-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudsupport-v2beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-cloudusersettings-pa-
dictionary_item_added
  • root['schemas']['AutopushCloudusersettingsPaSandboxCustomExperimentDiversionProperty']
  • root['schemas']['AutopushCloudusersettingsPaSandboxCloudAiPlatformUiSettings']['properties']['lastAdvancedDropdownCollapsedState']
  • root['schemas']['AutopushCloudusersettingsPaSandboxCloudAiPlatformUiSettings']['properties']['lastOutputsDropdownCollapsedState']
  • root['schemas']['AutopushCloudusersettingsPaSandboxCloudAiPlatformUiSettings']['properties']['lastPromptConfigPanelCollapsedState']
  • root['schemas']['AutopushCloudusersettingsPaSandboxCloudAiPlatformUiSettings']['properties']['lastToolsDropdownCollapsedState']
  • root['schemas']['AutopushCloudusersettingsPaSandboxPlatformExperimentDiversionProperty']['properties']['customExperimentDiversionProperty']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-cloudusersettings-pa-v1alpha1
dictionary_item_added
  • root['schemas']['AutopushCloudusersettingsPaSandboxCustomExperimentDiversionProperty']
  • root['schemas']['AutopushCloudusersettingsPaSandboxCloudAiPlatformUiSettings']['properties']['lastAdvancedDropdownCollapsedState']
  • root['schemas']['AutopushCloudusersettingsPaSandboxCloudAiPlatformUiSettings']['properties']['lastOutputsDropdownCollapsedState']
  • root['schemas']['AutopushCloudusersettingsPaSandboxCloudAiPlatformUiSettings']['properties']['lastPromptConfigPanelCollapsedState']
  • root['schemas']['AutopushCloudusersettingsPaSandboxCloudAiPlatformUiSettings']['properties']['lastToolsDropdownCollapsedState']
  • root['schemas']['AutopushCloudusersettingsPaSandboxPlatformExperimentDiversionProperty']['properties']['customExperimentDiversionProperty']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-datamixer-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-datamixer-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-developerconnect-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-developerconnect-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-developerconnect-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-dlp-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-drivefrontend-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-drivefrontend-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-drivequal-drivemetadata-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-drivequal-drivemetadata-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-drivequal-drivemetadata-v1alpha
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-emmapplecodevice-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-emmapplecodevice-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-essentialcontacts-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-essentialcontacts-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-essentialcontacts-v1alpha1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-essentialcontacts-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-familymanagement-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-familymanagement-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-fiamserver-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-fiamserver-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebaseappcheck-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebaseappcheck-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebaseappcheck-v1beta
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebaseappdistribution-
dictionary_item_added
  • root['resources']['projects']['methods']
  • root['schemas']['GoogleFirebaseAppdistroV1alphaTestQuota']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebaseappdistribution-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebaseappdistribution-v1alpha
dictionary_item_added
  • root['resources']['projects']['methods']
  • root['schemas']['GoogleFirebaseAppdistroV1alphaTestQuota']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebasedomains-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebasedomains-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebasedomains-pa-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebasedurablelinks-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebasedurablelinks-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebaseextensions-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebaseextensions-v1beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebaseextensionspublisher-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebaseextensionspublisher-v1beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebasehosting-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebasehosting-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebasehosting-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebasemessagingcampaigns-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebasemessagingcampaigns-v1beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebaseperusertopics-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebaseperusertopics-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-firebaseremoteconfig-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebaseremoteconfig-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebaseremoteconfig-pa-v2
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebasesagepredictions-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-firebasesagepredictions-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-fireconsole-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-fireconsole-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-geofeedtaskrouting-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-geofeedtaskrouting-v1alpha
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-gkeonprem-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-gkeonprem-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/autopush-growth-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-growth-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-instantmessaging-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-instantmessaging-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-integrations-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-integrations-v1
dictionary_item_removed
  • root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integrationRegion']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integration']['description']
new_valueRequired. Resource Name of the integration where template needs to be imported/inserted.
old_valueRequired. Name of the integration where template needs to be imported.
sandbox/autopush-integrations-v1alpha
dictionary_item_removed
  • root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integrationRegion']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integration']['description']
new_valueRequired. Resource Name of the integration where template needs to be imported/inserted.
old_valueRequired. Name of the integration where template needs to be imported.
sandbox/autopush-integrations-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-jibemessagestore-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-jibemessagestore-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-kidsmanagement-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-kidsmanagement-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-kidsnotification-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-kidsnotification-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-mapsplatformdatasets-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-mapsplatformdatasets-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-mapsplatformdatasets-v1alpha
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-meet-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-meet-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-meet-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-mobileperformancereporting-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-mobileperformancereporting-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-mobileperformancereporting-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-mobileperformancereporting-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-myphonenumbers-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
iterable_item_added
root['resources']['users']['resources']['me']['resources']['phoneNumbers']['resources']['service']['methods']['delete']['parameters']['phoneNumber.verification.type']['enum'][18]BRAND_ACCOUNT_TO_GOOGLE_ACCOUNT_MIGRATION
root['resources']['users']['resources']['me']['resources']['phoneNumbers']['resources']['service']['methods']['delete']['parameters']['phoneNumber.verification.type']['enumDescriptions'][18]When migrating Brand Accounts to Google Accounts (go/batuco-m1-dd:update-recovery-phone), we copy the recovery phone from the migration requester to the Brand Account. If the migration requester has a verified recovery phone, we will create a verification for the Brand account before Google was founded. See go/batuco-dd for more details.
root['schemas']['Verification']['properties']['type']['enum'][18]BRAND_ACCOUNT_TO_GOOGLE_ACCOUNT_MIGRATION
root['schemas']['Verification']['properties']['type']['enumDescriptions'][18]When migrating Brand Accounts to Google Accounts (go/batuco-m1-dd:update-recovery-phone), we copy the recovery phone from the migration requester to the Brand Account. If the migration requester has a verified recovery phone, we will create a verification for the Brand account before Google was founded. See go/batuco-dd for more details.
sandbox/autopush-myphonenumbers-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
iterable_item_added
root['resources']['users']['resources']['me']['resources']['phoneNumbers']['resources']['service']['methods']['delete']['parameters']['phoneNumber.verification.type']['enum'][18]BRAND_ACCOUNT_TO_GOOGLE_ACCOUNT_MIGRATION
root['resources']['users']['resources']['me']['resources']['phoneNumbers']['resources']['service']['methods']['delete']['parameters']['phoneNumber.verification.type']['enumDescriptions'][18]When migrating Brand Accounts to Google Accounts (go/batuco-m1-dd:update-recovery-phone), we copy the recovery phone from the migration requester to the Brand Account. If the migration requester has a verified recovery phone, we will create a verification for the Brand account before Google was founded. See go/batuco-dd for more details.
root['schemas']['Verification']['properties']['type']['enum'][18]BRAND_ACCOUNT_TO_GOOGLE_ACCOUNT_MIGRATION
root['schemas']['Verification']['properties']['type']['enumDescriptions'][18]When migrating Brand Accounts to Google Accounts (go/batuco-m1-dd:update-recovery-phone), we copy the recovery phone from the migration requester to the Brand Account. If the migration requester has a verified recovery phone, we will create a verification for the Brand account before Google was founded. See go/batuco-dd for more details.
sandbox/autopush-notifications-pa-
dictionary_item_added
  • root['schemas']['GoogleLogsTapandpayAndroid__PassesGeofencingEvent']
  • root['schemas']['WalletGooglepayCommon__IdCardCtaTarget']
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__PassTarget']['properties']['attachmentIndex']
  • root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['properties']['passesGeofencingEvent']
  • root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['properties']['isWearAppInBackground']
  • root['schemas']['WalletGooglepayCommon__MdocUnderReviewTarget']['properties']['screenType']
  • root['schemas']['WalletGooglepayCommon__NavigationTarget']['properties']['idCardCta']
dictionary_item_removed
  • root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['properties']['isAppInBackground']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleInternalTapandpayV1PassesTemplates__PassTarget']['description']
new_valueAn action to take that is related to a specific pass. Objects that contain a target that is unrecognized or that is not known how to be handled by the current client version should hide the object instead of showing it. Next ID: 12
old_valueAn action to take that is related to a specific pass. Objects that contain a target that is unrecognized or that is not known how to be handled by the current client version should hide the object instead of showing it. Next ID: 11
root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['description']
new_valueTop-level extension to be reported Next id: 209
old_valueTop-level extension to be reported Next id: 208
root['schemas']['WalletGooglepayCommon__MdocUnderReviewTarget']['description']
new_valueA target to intent to the mdoc under review screen. Next id: 4
old_valueA target to intent to the mdoc under review screen. Next id: 3
root['schemas']['WalletGooglepayCommon__NavigationTarget']['description']
new_valueThe target to navigate to. A target should be a pure navigation target. I.e. the target should not represent an action to be taken (besides navigation). Next id: 73
old_valueThe target to navigate to. A target should be a pure navigation target. I.e. the target should not represent an action to be taken (besides navigation). Next id: 72
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__BackupRestoreEvent']['properties']['errorType']['enum'][9]NO_DATA_TO_RESTORE
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][211]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_ATTEMPT
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][212]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_LOCK_ACQUIRED
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][213]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_LOCK_CONTENTION_RESCHEDULE_NEEDED
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][214]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_LOCK_CONTENTION_RESCHEDULE_NOT_NEEDED
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][211]Events for collecting and analyzing lock contention during checking and updating bundles with ClosedLoopBundleManager. Event for when a bundle check is attempted.
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][212]Event for when the lock is successfully acquired.
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][213]Event for when the lock contention is detected and bundle check reschedule is needed.
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][214]Event for when the lock contention is detected but bundle check reschedule is not needed.
sandbox/autopush-notifications-pa-v1
dictionary_item_added
  • root['schemas']['GoogleLogsTapandpayAndroid__PassesGeofencingEvent']
  • root['schemas']['WalletGooglepayCommon__IdCardCtaTarget']
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__PassTarget']['properties']['attachmentIndex']
  • root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['properties']['passesGeofencingEvent']
  • root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['properties']['isWearAppInBackground']
  • root['schemas']['WalletGooglepayCommon__MdocUnderReviewTarget']['properties']['screenType']
  • root['schemas']['WalletGooglepayCommon__NavigationTarget']['properties']['idCardCta']
dictionary_item_removed
  • root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['properties']['isAppInBackground']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleInternalTapandpayV1PassesTemplates__PassTarget']['description']
new_valueAn action to take that is related to a specific pass. Objects that contain a target that is unrecognized or that is not known how to be handled by the current client version should hide the object instead of showing it. Next ID: 12
old_valueAn action to take that is related to a specific pass. Objects that contain a target that is unrecognized or that is not known how to be handled by the current client version should hide the object instead of showing it. Next ID: 11
root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['description']
new_valueTop-level extension to be reported Next id: 209
old_valueTop-level extension to be reported Next id: 208
root['schemas']['WalletGooglepayCommon__MdocUnderReviewTarget']['description']
new_valueA target to intent to the mdoc under review screen. Next id: 4
old_valueA target to intent to the mdoc under review screen. Next id: 3
root['schemas']['WalletGooglepayCommon__NavigationTarget']['description']
new_valueThe target to navigate to. A target should be a pure navigation target. I.e. the target should not represent an action to be taken (besides navigation). Next id: 73
old_valueThe target to navigate to. A target should be a pure navigation target. I.e. the target should not represent an action to be taken (besides navigation). Next id: 72
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__BackupRestoreEvent']['properties']['errorType']['enum'][9]NO_DATA_TO_RESTORE
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][211]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_ATTEMPT
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][212]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_LOCK_ACQUIRED
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][213]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_LOCK_CONTENTION_RESCHEDULE_NEEDED
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][214]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_LOCK_CONTENTION_RESCHEDULE_NOT_NEEDED
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][211]Events for collecting and analyzing lock contention during checking and updating bundles with ClosedLoopBundleManager. Event for when a bundle check is attempted.
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][212]Event for when the lock is successfully acquired.
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][213]Event for when the lock contention is detected and bundle check reschedule is needed.
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][214]Event for when the lock contention is detected but bundle check reschedule is not needed.
sandbox/autopush-ogads-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-ogads-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-paisadatamixer-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-paisadatamixer-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-people-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-people-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-peoplestack-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-peoplestack-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-policysimulator-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-policysimulator-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-policysimulator-v1alpha
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-policysimulator-v1beta
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-policytroubleshooter-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-policytroubleshooter-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-policytroubleshooter-v1beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-policytroubleshooter-v2alpha1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-policytroubleshooter-v3
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-policytroubleshooter-v3alpha
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-policytroubleshooter-v3beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-reauth-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-reauth-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-reauth-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-recaptchaenterprise-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-recaptchaenterprise-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-recaptchaenterprise-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-serviceusage-
dictionary_item_added
  • root['schemas']['PrivacyDataGovernanceAttributesPiiAndContentSanitization']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcess']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessBardHumanReview']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessSyft']
  • root['schemas']['PrivacyDataGovernanceAttributesAnnotationsDataCustom']['properties']['piiAndContentSanitization']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-serviceusage-v1
dictionary_item_added
  • root['schemas']['PrivacyDataGovernanceAttributesPiiAndContentSanitization']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcess']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessBardHumanReview']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessSyft']
  • root['schemas']['PrivacyDataGovernanceAttributesAnnotationsDataCustom']['properties']['piiAndContentSanitization']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-serviceusage-v1alpha
dictionary_item_added
  • root['schemas']['PrivacyDataGovernanceAttributesPiiAndContentSanitization']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcess']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessBardHumanReview']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessSyft']
  • root['schemas']['PrivacyDataGovernanceAttributesAnnotationsDataCustom']['properties']['piiAndContentSanitization']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-serviceusage-v1beta1
dictionary_item_added
  • root['schemas']['PrivacyDataGovernanceAttributesPiiAndContentSanitization']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcess']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessBardHumanReview']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessSyft']
  • root['schemas']['PrivacyDataGovernanceAttributesAnnotationsDataCustom']['properties']['piiAndContentSanitization']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-serviceusage-v2
dictionary_item_added
  • root['schemas']['PrivacyDataGovernanceAttributesPiiAndContentSanitization']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcess']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessBardHumanReview']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessSyft']
  • root['schemas']['PrivacyDataGovernanceAttributesAnnotationsDataCustom']['properties']['piiAndContentSanitization']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-serviceusage-v2alpha
dictionary_item_added
  • root['schemas']['PrivacyDataGovernanceAttributesPiiAndContentSanitization']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcess']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessBardHumanReview']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessSyft']
  • root['schemas']['PrivacyDataGovernanceAttributesAnnotationsDataCustom']['properties']['piiAndContentSanitization']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-serviceusage-v2beta
dictionary_item_added
  • root['schemas']['PrivacyDataGovernanceAttributesPiiAndContentSanitization']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcess']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessBardHumanReview']
  • root['schemas']['PrivacyDataGovernanceAttributesSanitizationProcessSyft']
  • root['schemas']['PrivacyDataGovernanceAttributesAnnotationsDataCustom']['properties']['piiAndContentSanitization']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-us-central1-cloudbuild-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-us-central1-cloudbuild-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-us-central1-cloudbuild-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-userguard-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-userguard-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-userguard-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/autopush-workspacevideo-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-workspacevideo-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/autopush-workstations-v1
dictionary_item_added
  • root['resources']['projects']['resources']['locations']['resources']
values_changed
root['description']
new_valueAllows administrators to create managed developer environments in the cloud.
old_value
root['resources']['projects']['resources']['locations']['methods']['get']['response']['$ref']
new_valueLocation
old_valueGoogleCloudLocationLocation
root['resources']['projects']['resources']['locations']['methods']['list']['response']['$ref']
new_valueListLocationsResponse
old_valueGoogleCloudLocationListLocationsResponse
root['revision']
new_value20250219
old_value20230223
root['schemas']
new_value
Accelerator
descriptionAn accelerator card attached to the instance.
idAccelerator
properties
count
descriptionOptional. Number of accelerator cards exposed to the instance.
formatint32
typeinteger
type
descriptionOptional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`.
typestring
typeobject
AuditConfig
descriptionSpecifies 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.
idAuditConfig
properties
auditLogConfigs
descriptionThe configuration for logging of each type of permission.
items
$refAuditLogConfig
typearray
service
descriptionSpecifies 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.
typestring
typeobject
AuditLogConfig
descriptionProvides 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.
idAuditLogConfig
properties
exemptedMembers
descriptionSpecifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
items
typestring
typearray
logType
descriptionThe log type that this config enables.
enum
  • LOG_TYPE_UNSPECIFIED
  • ADMIN_READ
  • DATA_WRITE
  • DATA_READ
enumDescriptions
  • Default case. Should never be this.
  • Admin reads. Example: CloudIAM getIamPolicy
  • Data writes. Example: CloudSQL Users create
  • Data reads. Example: CloudSQL Users list
typestring
typeobject
Binding
descriptionAssociates `members`, or principals, with a `role`.
idBinding
properties
condition
$refExpr
descriptionThe 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).
members
descriptionSpecifies 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`.
items
typestring
typearray
role
descriptionRole 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).
typestring
typeobject
BoostConfig
descriptionA boost configuration is a set of resources that a workstation can use to increase its performance. If you specify a boost configuration, upon startup, workstation users can choose to use a VM provisioned under the boost config by passing the boost config ID in the start request. If the workstation user does not provide a boost config ID in the start request, the system will choose a VM from the pool provisioned under the default config.
idBoostConfig
properties
accelerators
descriptionOptional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to `none`.
items
$refAccelerator
typearray
bootDiskSizeGb
descriptionOptional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB.
formatint32
typeinteger
enableNestedVirtualization
descriptionOptional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series.
typeboolean
id
descriptionRequired. The ID to be used for the boost configuration.
typestring
machineType
descriptionOptional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`.
typestring
poolSize
descriptionOptional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`.
formatint32
typeinteger
typeobject
CancelOperationRequest
descriptionThe request message for Operations.CancelOperation.
idCancelOperationRequest
properties
typeobject
Container
descriptionA Docker container.
idContainer
properties
args
descriptionOptional. Arguments passed to the entrypoint.
items
typestring
typearray
command
descriptionOptional. If set, overrides the default ENTRYPOINT specified by the image.
items
typestring
typearray
env
additionalProperties
typestring
descriptionOptional. Environment variables passed to the container's entrypoint.
typeobject
image
descriptionOptional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of [preconfigured images](https://cloud.google.com/workstations/docs/preconfigured-base-images), but you can create your own [custom container images](https://cloud.google.com/workstations/docs/custom-container-images). If using a private image, the `host.gceInstance.serviceAccount` field must be specified in the workstation configuration. If using a custom container image, the service account must have [Artifact Registry Reader](https://cloud.google.com/artifact-registry/docs/access-control#roles) permission to pull the specified image. Otherwise, the image must be publicly accessible.
typestring
runAsUser
descriptionOptional. If set, overrides the USER specified in the image with the given uid.
formatint32
typeinteger
workingDir
descriptionOptional. If set, overrides the default DIR specified by the image.
typestring
typeobject
CustomerEncryptionKey
descriptionA customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties).
idCustomerEncryptionKey
properties
kmsKey
descriptionImmutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration.
typestring
kmsKeyServiceAccount
descriptionImmutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member).
typestring
typeobject
DomainConfig
descriptionConfiguration options for a custom domain.
idDomainConfig
properties
domain
descriptionImmutable. Domain used by Workstations for HTTP ingress.
typestring
typeobject
EphemeralDirectory
descriptionAn ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.
idEphemeralDirectory
properties
gcePd
$refGcePersistentDisk
descriptionAn EphemeralDirectory backed by a Compute Engine persistent disk.
mountPath
descriptionRequired. Location of this directory in the running workstation.
typestring
typeobject
Expr
descriptionRepresents 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.
idExpr
properties
description
descriptionOptional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
typestring
expression
descriptionTextual representation of an expression in Common Expression Language syntax.
typestring
location
descriptionOptional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
typestring
title
descriptionOptional. 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.
typestring
typeobject
GceConfidentialInstanceConfig
descriptionA set of Compute Engine Confidential VM instance options.
idGceConfidentialInstanceConfig
properties
enableConfidentialCompute
descriptionOptional. Whether the instance has confidential compute enabled.
typeboolean
typeobject
GceInstance
descriptionA runtime using a Compute Engine instance.
idGceInstance
properties
accelerators
descriptionOptional. A list of the type and count of accelerator cards attached to the instance.
items
$refAccelerator
typearray
boostConfigs
descriptionOptional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
items
$refBoostConfig
typearray
bootDiskSizeGb
descriptionOptional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB.
formatint32
typeinteger
confidentialInstanceConfig
$refGceConfidentialInstanceConfig
descriptionOptional. A set of Compute Engine Confidential VM instance options.
disablePublicIpAddresses
descriptionOptional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses).
typeboolean
disableSsh
descriptionOptional. Whether to disable SSH access to the VM.
typeboolean
enableNestedVirtualization
descriptionOptional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series.
typeboolean
machineType
descriptionOptional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types).
typestring
poolSize
descriptionOptional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API.
formatint32
typeinteger
pooledInstances
descriptionOutput only. Number of instances currently available in the pool for faster workstation startup.
formatint32
readOnlyTrue
typeinteger
serviceAccount
descriptionOptional. The email address of the service account for Cloud Workstations VMs created with this configuration. When specified, be sure that the service account has `logging.logEntries.create` and `monitoring.timeSeries.create` permissions on the project so it can write logs out to Cloud Logging. If using a custom container image, the service account must have [Artifact Registry Reader](https://cloud.google.com/artifact-registry/docs/access-control#roles) permission to pull the specified image. If you as the administrator want to be able to `ssh` into the underlying VM, you need to set this value to a service account for which you have the `iam.serviceAccounts.actAs` permission. Conversely, if you don't want anyone to be able to `ssh` into the underlying VM, use a service account where no one has that permission. If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
typestring
serviceAccountScopes
descriptionOptional. Scopes to grant to the service_account. When specified, users of workstations under this configuration must have `iam.serviceAccounts.actAs` on the service account.
items
typestring
typearray
shieldedInstanceConfig
$refGceShieldedInstanceConfig
descriptionOptional. A set of Compute Engine Shielded instance options.
tags
descriptionOptional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies [network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs created with this configuration. These network tags enable the creation of [firewall rules](https://cloud.google.com/workstations/docs/configure-firewall-rules).
items
typestring
typearray
vmTags
additionalProperties
typestring
descriptionOptional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as [resource manager tags](https://cloud.google.com/resource-manager/docs/tags/tags-overview). Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`.
typeobject
typeobject
GceInstanceHost
descriptionThe Compute Engine instance host.
idGceInstanceHost
properties
id
descriptionOptional. Output only. The ID of the Compute Engine instance.
readOnlyTrue
typestring
name
descriptionOptional. Output only. The name of the Compute Engine instance.
readOnlyTrue
typestring
zone
descriptionOptional. Output only. The zone of the Compute Engine instance.
readOnlyTrue
typestring
typeobject
GcePersistentDisk
descriptionAn EphemeralDirectory is backed by a Compute Engine persistent disk.
idGcePersistentDisk
properties
diskType
descriptionOptional. Type of the disk to use. Defaults to `"pd-standard"`.
typestring
readOnly
descriptionOptional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and source_snapshot must be set.
typeboolean
sourceImage
descriptionOptional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable.
typestring
sourceSnapshot
descriptionOptional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable.
typestring
typeobject
GceRegionalPersistentDisk
descriptionA Persistent Directory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that mounts to the workstation VM at `/home` when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.
idGceRegionalPersistentDisk
properties
diskType
descriptionOptional. The [type of the persistent disk](https://cloud.google.com/compute/docs/disks#disk-types) for the home directory. Defaults to `"pd-standard"`.
typestring
fsType
descriptionOptional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. Defaults to `"ext4"`.
typestring
reclaimPolicy
descriptionOptional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`.
enum
  • RECLAIM_POLICY_UNSPECIFIED
  • DELETE
  • RETAIN
enumDescriptions
  • Do not use.
  • Delete the persistent disk when deleting the workstation.
  • Keep the persistent disk when deleting the workstation. An administrator must manually delete the disk.
typestring
sizeGb
descriptionOptional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. If less than `200` GB, the disk_type must be `"pd-balanced"` or `"pd-ssd"`.
formatint32
typeinteger
sourceSnapshot
descriptionOptional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.
typestring
typeobject
GceShieldedInstanceConfig
descriptionA set of Compute Engine Shielded instance options.
idGceShieldedInstanceConfig
properties
enableIntegrityMonitoring
descriptionOptional. Whether the instance has integrity monitoring enabled.
typeboolean
enableSecureBoot
descriptionOptional. Whether the instance has Secure Boot enabled.
typeboolean
enableVtpm
descriptionOptional. Whether the instance has the vTPM enabled.
typeboolean
typeobject
GenerateAccessTokenRequest
descriptionRequest message for GenerateAccessToken.
idGenerateAccessTokenRequest
properties
expireTime
descriptionDesired expiration time of the access token. This value must be at most 24 hours in the future. If a value is not specified, the token's expiration time will be set to a default value of 1 hour in the future.
formatgoogle-datetime
typestring
port
descriptionOptional. Port for which the access token should be generated. If specified, the generated access token grants access only to the specified port of the workstation. If specified, values must be within the range [1 - 65535]. If not specified, the generated access token grants access to all ports of the workstation.
formatint32
typeinteger
ttl
descriptionDesired lifetime duration of the access token. This value must be at most 24 hours. If a value is not specified, the token's lifetime will be set to a default value of 1 hour.
formatgoogle-duration
typestring
typeobject
GenerateAccessTokenResponse
descriptionResponse message for GenerateAccessToken.
idGenerateAccessTokenResponse
properties
accessToken
descriptionThe generated bearer access token. To use this token, include it in an Authorization header of an HTTP request sent to the associated workstation's hostname—for example, `Authorization: Bearer `.
typestring
expireTime
descriptionTime at which the generated token will expire.
formatgoogle-datetime
typestring
typeobject
GoogleProtobufEmpty
descriptionA 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); }
idGoogleProtobufEmpty
properties
typeobject
Host
descriptionRuntime host for a workstation.
idHost
properties
gceInstance
$refGceInstance
descriptionSpecifies a Compute Engine instance as the host.
typeobject
ListLocationsResponse
descriptionThe response message for Locations.ListLocations.
idListLocationsResponse
properties
locations
descriptionA list of locations that matches the specified filter in the request.
items
$refLocation
typearray
nextPageToken
descriptionThe standard List next-page token.
typestring
typeobject
ListOperationsResponse
descriptionThe response message for Operations.ListOperations.
idListOperationsResponse
properties
nextPageToken
descriptionThe standard List next-page token.
typestring
operations
descriptionA list of operations that matches the specified filter in the request.
items
$refOperation
typearray
typeobject
ListUsableWorkstationConfigsResponse
descriptionResponse message for ListUsableWorkstationConfigs.
idListUsableWorkstationConfigsResponse
properties
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionUnreachable resources.
items
typestring
typearray
workstationConfigs
descriptionThe requested configs.
items
$refWorkstationConfig
typearray
typeobject
ListUsableWorkstationsResponse
descriptionResponse message for ListUsableWorkstations.
idListUsableWorkstationsResponse
properties
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionUnreachable resources.
items
typestring
typearray
workstations
descriptionThe requested workstations.
items
$refWorkstation
typearray
typeobject
ListWorkstationClustersResponse
descriptionResponse message for ListWorkstationClusters.
idListWorkstationClustersResponse
properties
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionUnreachable resources.
items
typestring
typearray
workstationClusters
descriptionThe requested workstation clusters.
items
$refWorkstationCluster
typearray
typeobject
ListWorkstationConfigsResponse
descriptionResponse message for ListWorkstationConfigs.
idListWorkstationConfigsResponse
properties
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionUnreachable resources.
items
typestring
typearray
workstationConfigs
descriptionThe requested configs.
items
$refWorkstationConfig
typearray
typeobject
ListWorkstationsResponse
descriptionResponse message for ListWorkstations.
idListWorkstationsResponse
properties
nextPageToken
descriptionOptional. Token to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionOptional. Unreachable resources.
items
typestring
typearray
workstations
descriptionThe requested workstations.
items
$refWorkstation
typearray
typeobject
Location
descriptionA resource that represents a Google Cloud location.
idLocation
properties
displayName
descriptionThe friendly name for this location, typically a nearby city name. For example, "Tokyo".
typestring
labels
additionalProperties
typestring
descriptionCross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
typeobject
locationId
descriptionThe canonical id for this location. For example: `"us-east1"`.
typestring
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata. For example the available capacity at the given location.
typeobject
name
descriptionResource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
typestring
typeobject
Operation
descriptionThis resource represents a long-running operation that is the result of a network API call.
idOperation
properties
done
descriptionIf the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
typeboolean
error
$refStatus
descriptionThe error result of the operation in case of failure or cancellation.
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
typeobject
name
descriptionThe server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
typestring
response
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionThe normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
typeobject
typeobject
OperationMetadata
descriptionMetadata for long-running operations.
idOperationMetadata
properties
apiVersion
descriptionOutput only. API version used to start the operation.
readOnlyTrue
typestring
createTime
descriptionOutput only. Time that the operation was created.
formatgoogle-datetime
readOnlyTrue
typestring
endTime
descriptionOutput only. Time that the operation finished running.
formatgoogle-datetime
readOnlyTrue
typestring
requestedCancellation
descriptionOutput only. Identifies whether the user has requested cancellation of the operation.
readOnlyTrue
typeboolean
statusMessage
descriptionOutput only. Human-readable status of the operation, if any.
readOnlyTrue
typestring
target
descriptionOutput only. Server-defined resource path for the target of the operation.
readOnlyTrue
typestring
verb
descriptionOutput only. Name of the verb executed by the operation.
readOnlyTrue
typestring
typeobject
PersistentDirectory
descriptionA directory to persist across workstation sessions. Updates to this field will not update existing workstations and will only take effect on new workstations.
idPersistentDirectory
properties
gcePd
$refGceRegionalPersistentDisk
descriptionA PersistentDirectory backed by a Compute Engine persistent disk.
mountPath
descriptionOptional. Location of this directory in the running workstation.
typestring
typeobject
Policy
descriptionAn 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/).
idPolicy
properties
auditConfigs
descriptionSpecifies cloud audit logging configuration for this policy.
items
$refAuditConfig
typearray
bindings
descriptionAssociates 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`.
items
$refBinding
typearray
etag
description`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.
formatbyte
typestring
version
descriptionSpecifies 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).
formatint32
typeinteger
typeobject
PortRange
descriptionA PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.
idPortRange
properties
first
descriptionRequired. Starting port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535.
formatint32
typeinteger
last
descriptionRequired. Ending port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535.
formatint32
typeinteger
typeobject
PrivateClusterConfig
descriptionConfiguration options for private workstation clusters.
idPrivateClusterConfig
properties
allowedProjects
descriptionOptional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.
items
typestring
typearray
clusterHostname
descriptionOutput only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
readOnlyTrue
typestring
enablePrivateEndpoint
descriptionImmutable. Whether Workstations endpoint is private.
typeboolean
serviceAttachmentUri
descriptionOutput only. Service attachment URI for the workstation cluster. The service attachment is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
readOnlyTrue
typestring
typeobject
ReadinessCheck
descriptionA readiness check to be performed on a workstation.
idReadinessCheck
properties
path
descriptionOptional. Path to which the request should be sent.
typestring
port
descriptionOptional. Port to which the request should be sent.
formatint32
typeinteger
typeobject
RuntimeHost
descriptionRuntime host for the workstation.
idRuntimeHost
properties
gceInstanceHost
$refGceInstanceHost
descriptionSpecifies a Compute Engine instance as the host.
typeobject
SetIamPolicyRequest
descriptionRequest message for `SetIamPolicy` method.
idSetIamPolicyRequest
properties
policy
$refPolicy
descriptionREQUIRED: 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 a valid policy but certain Google Cloud services (such as Projects) might reject them.
updateMask
descriptionOPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
formatgoogle-fieldmask
typestring
typeobject
StartWorkstationRequest
descriptionRequest message for StartWorkstation.
idStartWorkstationRequest
properties
boostConfig
descriptionOptional. If set, the workstation starts using the boost configuration with the specified ID.
typestring
etag
descriptionOptional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
typeboolean
typeobject
Status
descriptionThe `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).
idStatus
properties
code
descriptionThe status code, which should be an enum value of google.rpc.Code.
formatint32
typeinteger
details
descriptionA list of messages that carry the error details. There is a common set of message types for APIs to use.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
message
descriptionA 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.
typestring
typeobject
StopWorkstationRequest
descriptionRequest message for StopWorkstation.
idStopWorkstationRequest
properties
etag
descriptionOptional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
typeboolean
typeobject
TestIamPermissionsRequest
descriptionRequest message for `TestIamPermissions` method.
idTestIamPermissionsRequest
properties
permissions
descriptionThe set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
items
typestring
typearray
typeobject
TestIamPermissionsResponse
descriptionResponse message for `TestIamPermissions` method.
idTestIamPermissionsResponse
properties
permissions
descriptionA subset of `TestPermissionsRequest.permissions` that the caller is allowed.
items
typestring
typearray
typeobject
Workstation
descriptionA single instance of a developer workstation with its own persistent storage.
idWorkstation
properties
annotations
additionalProperties
typestring
descriptionOptional. Client-specified annotations.
typeobject
createTime
descriptionOutput only. Time when this workstation was created.
formatgoogle-datetime
readOnlyTrue
typestring
deleteTime
descriptionOutput only. Time when this workstation was soft-deleted.
formatgoogle-datetime
readOnlyTrue
typestring
displayName
descriptionOptional. Human-readable name for this workstation.
typestring
env
additionalProperties
typestring
descriptionOptional. Environment variables passed to the workstation container's entrypoint.
typeobject
etag
descriptionOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
typestring
host
descriptionOutput only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`.
readOnlyTrue
typestring
kmsKey
descriptionOutput only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
readOnlyTrue
typestring
labels
additionalProperties
typestring
descriptionOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.
typeobject
name
descriptionIdentifier. Full name of this workstation.
typestring
reconciling
descriptionOutput only. Indicates whether this workstation is currently being updated to match its intended state.
readOnlyTrue
typeboolean
runtimeHost
$refRuntimeHost
descriptionOptional. Output only. Runtime host for the workstation when in STATE_RUNNING.
readOnlyTrue
sourceWorkstation
descriptionOptional. The source workstation from which this workstation's persistent directories were cloned on creation.
typestring
startTime
descriptionOutput only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.
formatgoogle-datetime
readOnlyTrue
typestring
state
descriptionOutput only. Current state of the workstation.
enum
  • STATE_UNSPECIFIED
  • STATE_STARTING
  • STATE_RUNNING
  • STATE_STOPPING
  • STATE_STOPPED
enumDescriptions
  • Do not use.
  • The workstation is not yet ready to accept requests from users but will be soon.
  • The workstation is ready to accept requests from users.
  • The workstation is being stopped.
  • The workstation is stopped and will not be able to receive requests until it is started.
readOnlyTrue
typestring
uid
descriptionOutput only. A system-assigned unique identifier for this workstation.
readOnlyTrue
typestring
updateTime
descriptionOutput only. Time when this workstation was most recently updated.
formatgoogle-datetime
readOnlyTrue
typestring
typeobject
WorkstationCluster
descriptionA workstation cluster resource in the Cloud Workstations API. Defines a group of workstations in a particular region and the VPC network they're attached to.
idWorkstationCluster
properties
annotations
additionalProperties
typestring
descriptionOptional. Client-specified annotations.
typeobject
conditions
descriptionOutput only. Status conditions describing the workstation cluster's current state.
items
$refStatus
readOnlyTrue
typearray
controlPlaneIp
descriptionOutput only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.
readOnlyTrue
typestring
createTime
descriptionOutput only. Time when this workstation cluster was created.
formatgoogle-datetime
readOnlyTrue
typestring
degraded
descriptionOutput only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
readOnlyTrue
typeboolean
deleteTime
descriptionOutput only. Time when this workstation cluster was soft-deleted.
formatgoogle-datetime
readOnlyTrue
typestring
displayName
descriptionOptional. Human-readable name for this workstation cluster.
typestring
domainConfig
$refDomainConfig
descriptionOptional. Configuration options for a custom domain.
etag
descriptionOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
typestring
labels
additionalProperties
typestring
descriptionOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
typeobject
name
descriptionIdentifier. Full name of this workstation cluster.
typestring
network
descriptionImmutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
typestring
privateClusterConfig
$refPrivateClusterConfig
descriptionOptional. Configuration for private workstation cluster.
reconciling
descriptionOutput only. Indicates whether this workstation cluster is currently being updated to match its intended state.
readOnlyTrue
typeboolean
subnetwork
descriptionImmutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.
typestring
tags
additionalProperties
typestring
descriptionOptional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
typeobject
uid
descriptionOutput only. A system-assigned unique identifier for this workstation cluster.
readOnlyTrue
typestring
updateTime
descriptionOutput only. Time when this workstation cluster was most recently updated.
formatgoogle-datetime
readOnlyTrue
typestring
typeobject
WorkstationConfig
descriptionA workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers.
idWorkstationConfig
properties
allowedPorts
descriptionOptional. A list of PortRanges specifying single ports or ranges of ports that are externally accessible in the workstation. Allowed ports must be one of 22, 80, or within range 1024-65535. If not specified defaults to ports 22, 80, and ports 1024-65535.
items
$refPortRange
typearray
annotations
additionalProperties
typestring
descriptionOptional. Client-specified annotations.
typeobject
conditions
descriptionOutput only. Status conditions describing the current resource state.
items
$refStatus
readOnlyTrue
typearray
container
$refContainer
descriptionOptional. Container that runs upon startup for each workstation using this workstation configuration.
createTime
descriptionOutput only. Time when this workstation configuration was created.
formatgoogle-datetime
readOnlyTrue
typestring
degraded
descriptionOutput only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
readOnlyTrue
typeboolean
deleteTime
descriptionOutput only. Time when this workstation configuration was soft-deleted.
formatgoogle-datetime
readOnlyTrue
typestring
disableTcpConnections
descriptionOptional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS.
typeboolean
displayName
descriptionOptional. Human-readable name for this workstation configuration.
typestring
enableAuditAgent
descriptionOptional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](https://cloud.google.com/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd"
typeboolean
encryptionKey
$refCustomerEncryptionKey
descriptionImmutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created.
ephemeralDirectories
descriptionOptional. Ephemeral directories which won't persist across workstation sessions.
items
$refEphemeralDirectory
typearray
etag
descriptionOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
typestring
grantWorkstationAdminRoleOnCreate
descriptionOptional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false.
typeboolean
host
$refHost
descriptionOptional. Runtime host for the workstation.
idleTimeout
descriptionOptional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes).
formatgoogle-duration
typestring
labels
additionalProperties
typestring
descriptionOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
typeobject
maxUsableWorkstations
descriptionOptional. Maximum number of workstations under this configuration a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified, defaults to `0`, which indicates unlimited.
formatint32
typeinteger
name
descriptionIdentifier. Full name of this workstation configuration.
typestring
persistentDirectories
descriptionOptional. Directories to persist across workstation sessions.
items
$refPersistentDirectory
typearray
readinessChecks
descriptionOptional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
items
$refReadinessCheck
typearray
reconciling
descriptionOutput only. Indicates whether this workstation configuration is currently being updated to match its intended state.
readOnlyTrue
typeboolean
replicaZones
descriptionOptional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created.
items
typestring
typearray
runningTimeout
descriptionOptional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.
formatgoogle-duration
typestring
uid
descriptionOutput only. A system-assigned unique identifier for this workstation configuration.
readOnlyTrue
typestring
updateTime
descriptionOutput only. Time when this workstation configuration was most recently updated.
formatgoogle-datetime
readOnlyTrue
typestring
typeobject
old_value
GoogleCloudCommonOperationMetadata
descriptionRepresents the metadata of the long-running operation.
idGoogleCloudCommonOperationMetadata
properties
apiVersion
descriptionOutput only. API version used to start the operation.
readOnlyTrue
typestring
cancelRequested
descriptionOutput only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
readOnlyTrue
typeboolean
createTime
descriptionOutput only. The time the operation was created.
formatgoogle-datetime
readOnlyTrue
typestring
endTime
descriptionOutput only. The time the operation finished running.
formatgoogle-datetime
readOnlyTrue
typestring
statusDetail
descriptionOutput only. Human-readable status of the operation, if any.
readOnlyTrue
typestring
target
descriptionOutput only. Server-defined resource path for the target of the operation.
readOnlyTrue
typestring
verb
descriptionOutput only. Name of the verb executed by the operation.
readOnlyTrue
typestring
typeobject
GoogleCloudLocationListLocationsResponse
descriptionThe response message for Locations.ListLocations.
idGoogleCloudLocationListLocationsResponse
properties
locations
descriptionA list of locations that matches the specified filter in the request.
items
$refGoogleCloudLocationLocation
typearray
nextPageToken
descriptionThe standard List next-page token.
typestring
typeobject
GoogleCloudLocationLocation
descriptionA resource that represents Google Cloud Platform location.
idGoogleCloudLocationLocation
properties
displayName
descriptionThe friendly name for this location, typically a nearby city name. For example, "Tokyo".
typestring
labels
additionalProperties
typestring
descriptionCross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
typeobject
locationId
descriptionThe canonical id for this location. For example: `"us-east1"`.
typestring
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata. For example the available capacity at the given location.
typeobject
name
descriptionResource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
typestring
typeobject
GoogleCloudWorkstationsV1betaOperationMetadata
descriptionMetadata for long-running operations.
idGoogleCloudWorkstationsV1betaOperationMetadata
properties
apiVersion
descriptionOutput only. API version used to start the operation.
readOnlyTrue
typestring
createTime
descriptionOutput only. Time that the operation was created.
formatgoogle-datetime
readOnlyTrue
typestring
endTime
descriptionOutput only. Time that the operation finished running.
formatgoogle-datetime
readOnlyTrue
typestring
requestedCancellation
descriptionOutput only. Identifies whether the user has requested cancellation of the operation.
readOnlyTrue
typeboolean
statusMessage
descriptionOutput only. Human-readable status of the operation, if any.
readOnlyTrue
typestring
target
descriptionOutput only. Server-defined resource path for the target of the operation.
readOnlyTrue
typestring
verb
descriptionOutput only. Name of the verb executed by the operation.
readOnlyTrue
typestring
typeobject
GoogleCloudWorkstationsV1mainOperationMetadata
descriptionMetadata for long-running operations.
idGoogleCloudWorkstationsV1mainOperationMetadata
properties
apiVersion
descriptionOutput only. API version used to start the operation.
readOnlyTrue
typestring
createTime
descriptionOutput only. Time that the operation was created.
formatgoogle-datetime
readOnlyTrue
typestring
endTime
descriptionOutput only. Time that the operation finished running.
formatgoogle-datetime
readOnlyTrue
typestring
requestedCancellation
descriptionOutput only. Identifies whether the user has requested cancellation of the operation.
readOnlyTrue
typeboolean
statusMessage
descriptionOutput only. Human-readable status of the operation, if any.
readOnlyTrue
typestring
target
descriptionOutput only. Server-defined resource path for the target of the operation.
readOnlyTrue
typestring
verb
descriptionOutput only. Name of the verb executed by the operation.
readOnlyTrue
typestring
typeobject
sandbox/autopush-workstations-v1alpha
values_changed
root['description']
new_valueAllows administrators to create managed developer environments in the cloud.
old_value
root['resources']['projects']['resources']['locations']['resources']['operations']['methods']['cancel']['description']
new_valueStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
old_valueStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
root['resources']['projects']['resources']['locations']['resources']['operations']['methods']['list']['description']
new_valueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
old_valueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
root['revision']
new_value20250219
old_value20230223
root['schemas']['Binding']['properties']['members']['description']
new_valueSpecifies 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`.
old_valueSpecifies 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`. * `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.
root['schemas']['Binding']['properties']['role']['description']
new_valueRole 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).
old_valueRole that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
root['schemas']['Operation']['properties']['response']['description']
new_valueThe normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
old_valueThe normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
root['schemas']['Policy']['description']
new_valueAn 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/).
old_valueAn 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/).
sandbox/autopush-workstations-v1beta
dictionary_item_added
  • root['schemas']['Accelerator']
  • root['schemas']['BoostConfig']
  • root['schemas']['DomainConfig']
  • root['schemas']['EphemeralDirectory']
  • root['schemas']['GceInstanceHost']
  • root['schemas']['GcePersistentDisk']
  • root['schemas']['HttpOptions']
  • root['schemas']['PortRange']
  • root['schemas']['ReadinessCheck']
  • root['schemas']['RuntimeHost']
  • root['schemas']['WorkstationBoostConfig']
  • root['schemas']['GceInstance']['properties']['accelerators']
  • root['schemas']['GceInstance']['properties']['boostConfigs']
  • root['schemas']['GceInstance']['properties']['disableSsh']
  • root['schemas']['GceInstance']['properties']['enableNestedVirtualization']
  • root['schemas']['GceInstance']['properties']['pooledInstances']
  • root['schemas']['GceInstance']['properties']['serviceAccountScopes']
  • root['schemas']['GceInstance']['properties']['vmTags']
  • root['schemas']['GenerateAccessTokenRequest']['properties']['port']
  • root['schemas']['StartWorkstationRequest']['properties']['boostConfig']
  • root['schemas']['Workstation']['properties']['boostConfigs']
  • root['schemas']['Workstation']['properties']['conditions']
  • root['schemas']['Workstation']['properties']['degraded']
  • root['schemas']['Workstation']['properties']['env']
  • root['schemas']['Workstation']['properties']['kmsKey']
  • root['schemas']['Workstation']['properties']['runtimeHost']
  • root['schemas']['Workstation']['properties']['satisfiesPzi']
  • root['schemas']['Workstation']['properties']['satisfiesPzs']
  • root['schemas']['Workstation']['properties']['sourceWorkstation']
  • root['schemas']['Workstation']['properties']['startTime']
  • root['schemas']['WorkstationCluster']['properties']['controlPlaneIp']
  • root['schemas']['WorkstationCluster']['properties']['domainConfig']
  • root['schemas']['WorkstationCluster']['properties']['satisfiesPzi']
  • root['schemas']['WorkstationCluster']['properties']['satisfiesPzs']
  • root['schemas']['WorkstationCluster']['properties']['tags']
  • root['schemas']['WorkstationConfig']['properties']['allowedPorts']
  • root['schemas']['WorkstationConfig']['properties']['disableTcpConnections']
  • root['schemas']['WorkstationConfig']['properties']['enableAuditAgent']
  • root['schemas']['WorkstationConfig']['properties']['ephemeralDirectories']
  • root['schemas']['WorkstationConfig']['properties']['grantWorkstationAdminRoleOnCreate']
  • root['schemas']['WorkstationConfig']['properties']['httpOptions']
  • root['schemas']['WorkstationConfig']['properties']['maxUsableWorkstations']
  • root['schemas']['WorkstationConfig']['properties']['readinessChecks']
  • root['schemas']['WorkstationConfig']['properties']['replicaZones']
  • root['schemas']['WorkstationConfig']['properties']['satisfiesPzi']
  • root['schemas']['WorkstationConfig']['properties']['satisfiesPzs']
values_changed
root['description']
new_valueAllows administrators to create managed developer environments in the cloud.
old_value
root['resources']['projects']['resources']['locations']['resources']['operations']['methods']['cancel']['description']
new_valueStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
old_valueStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
root['resources']['projects']['resources']['locations']['resources']['operations']['methods']['list']['description']
new_valueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
old_valueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['methods']['create']['parameters']['validateOnly']['description']
new_valueOptional. If set, validate the request and preview the review, but do not actually apply it.
old_valueIf set, validate the request and preview the review, but do not actually apply it.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['methods']['delete']['parameters']['etag']['description']
new_valueOptional. If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag.
old_valueIf set, the request will be rejected if the latest version of the workstation cluster on the server does not have this etag.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['methods']['delete']['parameters']['force']['description']
new_valueOptional. If set, any workstation configurations and workstations in the workstation cluster are also deleted. Otherwise, the request only works if the workstation cluster has no configurations or workstations.
old_valueIf set, any workstation configurations and workstations in the workstation cluster are also deleted. Otherwise, the request only works if the workstation cluster has no configurations or workstations.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['methods']['delete']['parameters']['validateOnly']['description']
new_valueOptional. If set, validate the request and preview the review, but do not apply it.
old_valueIf set, validate the request and preview the review, but do not apply it.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['methods']['list']['parameters']['pageSize']['description']
new_valueOptional. Maximum number of items to return.
old_valueMaximum number of items to return.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['methods']['list']['parameters']['pageToken']['description']
new_valueOptional. next_page_token value returned from a previous List request, if any.
old_valuenext_page_token value returned from a previous List request, if any.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['methods']['patch']['parameters']['allowMissing']['description']
new_valueOptional. If set, and the workstation cluster is not found, a new workstation cluster will be created. In this situation, update_mask is ignored.
old_valueIf set, and the workstation cluster is not found, a new workstation cluster will be created. In this situation, update_mask is ignored.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['methods']['patch']['parameters']['name']['description']
new_valueIdentifier. Full name of this workstation cluster.
old_valueFull name of this resource.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['methods']['patch']['parameters']['validateOnly']['description']
new_valueOptional. If set, validate the request and preview the review, but do not actually apply it.
old_valueIf set, validate the request and preview the review, but do not actually apply it.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['create']['parameters']['validateOnly']['description']
new_valueOptional. If set, validate the request and preview the review, but do not actually apply it.
old_valueIf set, validate the request and preview the review, but do not actually apply it.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['create']['parameters']['workstationConfigId']['description']
new_valueRequired. ID to use for the workstation configuration.
old_valueRequired. ID to use for the config.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['delete']['parameters']['etag']['description']
new_valueOptional. If set, the request is rejected if the latest version of the workstation configuration on the server does not have this ETag.
old_valueIf set, the request will be rejected if the latest version of the config on the server does not have this etag.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['delete']['parameters']['force']['description']
new_valueOptional. If set, any workstations in the workstation configuration are also deleted. Otherwise, the request works only if the workstation configuration has no workstations.
old_valueIf set, any Workstations in the config will also be deleted. Otherwise, the request will work only if the config has no workstations.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the workstation configuration to delete.
old_valueRequired. Name of the config to delete.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['delete']['parameters']['validateOnly']['description']
new_valueOptional. If set, validate the request and preview the review, but do not actually apply it.
old_valueIf set, validate the request and preview the review, but do not actually apply it.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['list']['parameters']['pageSize']['description']
new_valueOptional. Maximum number of items to return.
old_valueMaximum number of items to return.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['list']['parameters']['pageToken']['description']
new_valueOptional. next_page_token value returned from a previous List request, if any.
old_valuenext_page_token value returned from a previous List request, if any.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['listUsable']['parameters']['pageSize']['description']
new_valueOptional. Maximum number of items to return.
old_valueMaximum number of items to return.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['listUsable']['parameters']['pageToken']['description']
new_valueOptional. next_page_token value returned from a previous List request, if any.
old_valuenext_page_token value returned from a previous List request, if any.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['patch']['parameters']['allowMissing']['description']
new_valueOptional. If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored.
old_valueIf set, and the config is not found, a new config will be created. In this situation, update_mask is ignored.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['patch']['parameters']['name']['description']
new_valueIdentifier. Full name of this workstation configuration.
old_valueFull name of this resource.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['patch']['parameters']['updateMask']['description']
new_valueRequired. Mask specifying which fields in the workstation configuration should be updated.
old_valueRequired. Mask specifying which fields in the config should be updated.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['methods']['patch']['parameters']['validateOnly']['description']
new_valueOptional. If set, validate the request and preview the review, but do not actually apply it.
old_valueIf set, validate the request and preview the review, but do not actually apply it.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['create']['parameters']['validateOnly']['description']
new_valueOptional. If set, validate the request and preview the review, but do not actually apply it.
old_valueIf set, validate the request and preview the review, but do not actually apply it.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['delete']['parameters']['etag']['description']
new_valueOptional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
old_valueIf set, the request will be rejected if the latest version of the workstation on the server does not have this etag.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['delete']['parameters']['validateOnly']['description']
new_valueOptional. If set, validate the request and preview the review, but do not actually apply it.
old_valueIf set, validate the request and preview the review, but do not actually apply it.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['generateAccessToken']['description']
new_valueReturns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation. Once generated this token cannot be revoked and is good for the lifetime of the token.
old_valueReturns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['list']['description']
new_valueReturns all Workstations using the specified workstation configuration.
old_valueReturns all Workstations using the specified config.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['list']['parameters']['pageSize']['description']
new_valueOptional. Maximum number of items to return.
old_valueMaximum number of items to return.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['list']['parameters']['pageToken']['description']
new_valueOptional. next_page_token value returned from a previous List request, if any.
old_valuenext_page_token value returned from a previous List request, if any.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['listUsable']['description']
new_valueReturns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
old_valueReturns all Workstations using the specified config on which the caller has the "workstations.workstations.use" permission.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['listUsable']['parameters']['pageSize']['description']
new_valueOptional. Maximum number of items to return.
old_valueMaximum number of items to return.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['listUsable']['parameters']['pageToken']['description']
new_valueOptional. next_page_token value returned from a previous List request, if any.
old_valuenext_page_token value returned from a previous List request, if any.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['patch']['parameters']['allowMissing']['description']
new_valueOptional. If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored.
old_valueIf set, and the config is not found, a new config will be created. In this situation, update_mask is ignored.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['patch']['parameters']['name']['description']
new_valueIdentifier. Full name of this workstation.
old_valueFull name of this resource.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['patch']['parameters']['updateMask']['description']
new_valueRequired. Mask specifying which fields in the workstation configuration should be updated.
old_valueRequired. Mask specifying which fields in the config should be updated.
root['resources']['projects']['resources']['locations']['resources']['workstationClusters']['resources']['workstationConfigs']['resources']['workstations']['methods']['patch']['parameters']['validateOnly']['description']
new_valueOptional. If set, validate the request and preview the review, but do not actually apply it.
old_valueIf set, validate the request and preview the review, but do not actually apply it.
root['revision']
new_value20250219
old_value20230223
root['schemas']['Binding']['properties']['members']['description']
new_valueSpecifies 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`.
old_valueSpecifies 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`. * `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.
root['schemas']['Binding']['properties']['role']['description']
new_valueRole 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).
old_valueRole that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
root['schemas']['Container']['properties']['args']['description']
new_valueOptional. Arguments passed to the entrypoint.
old_valueArguments passed to the entrypoint.
root['schemas']['Container']['properties']['command']['description']
new_valueOptional. If set, overrides the default ENTRYPOINT specified by the image.
old_valueIf set, overrides the default ENTRYPOINT specified by the image.
root['schemas']['Container']['properties']['env']['description']
new_valueOptional. Environment variables passed to the container's entrypoint.
old_valueEnvironment variables passed to the container.
root['schemas']['Container']['properties']['image']['description']
new_valueOptional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of [preconfigured images](https://cloud.google.com/workstations/docs/preconfigured-base-images), but you can create your own [custom container images](https://cloud.google.com/workstations/docs/custom-container-images). If using a private image, the `host.gceInstance.serviceAccount` field must be specified in the workstation configuration. If using a custom container image, the service account must have [Artifact Registry Reader](https://cloud.google.com/artifact-registry/docs/access-control#roles) permission to pull the specified image. Otherwise, the image must be publicly accessible.
old_valueDocker image defining the container. This image must be accessible by the config's service account.
root['schemas']['Container']['properties']['runAsUser']['description']
new_valueOptional. If set, overrides the USER specified in the image with the given uid.
old_valueIf set, overrides the USER specified in the image with the given uid.
root['schemas']['Container']['properties']['workingDir']['description']
new_valueOptional. If set, overrides the default DIR specified by the image.
old_valueIf set, overrides the default DIR specified by the image.
root['schemas']['CustomerEncryptionKey']['description']
new_valueA customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties).
old_valueA customer-managed encryption key for the Compute Engine resources of this workstation configuration.
root['schemas']['CustomerEncryptionKey']['properties']['kmsKey']['description']
new_valueImmutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration.
old_valueThe name of the Google Cloud KMS encryption key. For example, `projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME`.
root['schemas']['CustomerEncryptionKey']['properties']['kmsKeyServiceAccount']['description']
new_valueImmutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member).
old_valueThe service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member).
root['schemas']['GceConfidentialInstanceConfig']['properties']['enableConfidentialCompute']['description']
new_valueOptional. Whether the instance has confidential compute enabled.
old_valueWhether the instance has confidential compute enabled.
root['schemas']['GceInstance']['properties']['bootDiskSizeGb']['description']
new_valueOptional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB.
old_valueSize of the boot disk in GB.
root['schemas']['GceInstance']['properties']['confidentialInstanceConfig']['description']
new_valueOptional. A set of Compute Engine Confidential VM instance options.
old_valueA set of Compute Engine Confidential VM instance options.
root['schemas']['GceInstance']['properties']['disablePublicIpAddresses']['description']
new_valueOptional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses).
old_valueWhether instances have no public IP address.
root['schemas']['GceInstance']['properties']['machineType']['description']
new_valueOptional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types).
old_valueThe name of a Compute Engine machine type.
root['schemas']['GceInstance']['properties']['poolSize']['description']
new_valueOptional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API.
old_valueNumber of instances to pool for faster workstation starup.
root['schemas']['GceInstance']['properties']['serviceAccount']['description']
new_valueOptional. The email address of the service account for Cloud Workstations VMs created with this configuration. When specified, be sure that the service account has `logging.logEntries.create` and `monitoring.timeSeries.create` permissions on the project so it can write logs out to Cloud Logging. If using a custom container image, the service account must have [Artifact Registry Reader](https://cloud.google.com/artifact-registry/docs/access-control#roles) permission to pull the specified image. If you as the administrator want to be able to `ssh` into the underlying VM, you need to set this value to a service account for which you have the `iam.serviceAccounts.actAs` permission. Conversely, if you don't want anyone to be able to `ssh` into the underlying VM, use a service account where no one has that permission. If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
old_valueEmail address of the service account that will be used on VM instances used to support this config. This service account must have permission to pull the specified container image. If not set, VMs will run without a service account, in which case the image must be publicly accessible.
root['schemas']['GceInstance']['properties']['shieldedInstanceConfig']['description']
new_valueOptional. A set of Compute Engine Shielded instance options.
old_valueA set of Compute Engine Shielded instance options.
root['schemas']['GceInstance']['properties']['tags']['description']
new_valueOptional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies [network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs created with this configuration. These network tags enable the creation of [firewall rules](https://cloud.google.com/workstations/docs/configure-firewall-rules).
old_valueNetwork tags to add to the Compute Engine machines backing the Workstations.
root['schemas']['GceRegionalPersistentDisk']['description']
new_valueA Persistent Directory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that mounts to the workstation VM at `/home` when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.
old_valueA PersistentDirectory backed by a Compute Engine regional persistent disk.
root['schemas']['GceRegionalPersistentDisk']['properties']['diskType']['description']
new_valueOptional. The [type of the persistent disk](https://cloud.google.com/compute/docs/disks#disk-types) for the home directory. Defaults to `"pd-standard"`.
old_valueType of the disk to use.
root['schemas']['GceRegionalPersistentDisk']['properties']['fsType']['description']
new_valueOptional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. Defaults to `"ext4"`.
old_valueType of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set.
root['schemas']['GceRegionalPersistentDisk']['properties']['reclaimPolicy']['description']
new_valueOptional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`.
old_valueWhat should happen to the disk after the workstation is deleted. Defaults to DELETE.
root['schemas']['GceRegionalPersistentDisk']['properties']['sizeGb']['description']
new_valueOptional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. If less than `200` GB, the disk_type must be `"pd-balanced"` or `"pd-ssd"`.
old_valueSize of the disk in GB. Must be empty if source_snapshot is set.
root['schemas']['GceRegionalPersistentDisk']['properties']['sourceSnapshot']['description']
new_valueOptional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.
old_valueName of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.
root['schemas']['GceShieldedInstanceConfig']['properties']['enableIntegrityMonitoring']['description']
new_valueOptional. Whether the instance has integrity monitoring enabled.
old_valueWhether the instance has integrity monitoring enabled.
root['schemas']['GceShieldedInstanceConfig']['properties']['enableSecureBoot']['description']
new_valueOptional. Whether the instance has Secure Boot enabled.
old_valueWhether the instance has Secure Boot enabled.
root['schemas']['GceShieldedInstanceConfig']['properties']['enableVtpm']['description']
new_valueOptional. Whether the instance has the vTPM enabled.
old_valueWhether the instance has the vTPM enabled.
root['schemas']['GenerateAccessTokenResponse']['properties']['accessToken']['description']
new_valueThe generated bearer access token. To use this token, include it in an Authorization header of an HTTP request sent to the associated workstation's hostname—for example, `Authorization: Bearer `.
old_valueThe generated bearer access token. To use this token, include it in an Authorization header of an HTTP request sent to the associated workstation's hostname, for example, `Authorization: Bearer `.
root['schemas']['ListWorkstationsResponse']['properties']['nextPageToken']['description']
new_valueOptional. Token to retrieve the next page of results, or empty if there are no more results in the list.
old_valueToken to retrieve the next page of results, or empty if there are no more results in the list.
root['schemas']['ListWorkstationsResponse']['properties']['unreachable']['description']
new_valueOptional. Unreachable resources.
old_valueUnreachable resources.
root['schemas']['Operation']['properties']['response']['description']
new_valueThe normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
old_valueThe normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
root['schemas']['PersistentDirectory']['description']
new_valueA directory to persist across workstation sessions. Updates to this field will not update existing workstations and will only take effect on new workstations.
old_valueA directory to persist across workstation sessions.
root['schemas']['PersistentDirectory']['properties']['mountPath']['description']
new_valueOptional. Location of this directory in the running workstation.
old_valueLocation of this directory in the running workstation.
root['schemas']['Policy']['description']
new_valueAn 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/).
old_valueAn 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/).
root['schemas']['PrivateClusterConfig']['description']
new_valueConfiguration options for private workstation clusters.
old_valueConfiguration options for private clusters.
root['schemas']['PrivateClusterConfig']['properties']['allowedProjects']['description']
new_valueOptional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.
old_valueAdditional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.
root['schemas']['PrivateClusterConfig']['properties']['clusterHostname']['description']
new_valueOutput only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
old_valueOutput only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
root['schemas']['PrivateClusterConfig']['properties']['serviceAttachmentUri']['description']
new_valueOutput only. Service attachment URI for the workstation cluster. The service attachment is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
old_valueOutput only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
root['schemas']['StartWorkstationRequest']['properties']['etag']['description']
new_valueOptional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
old_valueIf set, the request will be rejected if the latest version of the workstation on the server does not have this etag.
root['schemas']['StartWorkstationRequest']['properties']['validateOnly']['description']
new_valueOptional. If set, validate the request and preview the review, but do not actually apply it.
old_valueIf set, validate the request and preview the review, but do not actually apply it.
root['schemas']['StopWorkstationRequest']['properties']['etag']['description']
new_valueOptional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
old_valueIf set, the request will be rejected if the latest version of the workstation on the server does not have this etag.
root['schemas']['StopWorkstationRequest']['properties']['validateOnly']['description']
new_valueOptional. If set, validate the request and preview the review, but do not actually apply it.
old_valueIf set, validate the request and preview the review, but do not actually apply it.
root['schemas']['Workstation']['properties']['annotations']['description']
new_valueOptional. Client-specified annotations.
old_valueClient-specified annotations.
root['schemas']['Workstation']['properties']['createTime']['description']
new_valueOutput only. Time when this workstation was created.
old_valueOutput only. Time when this resource was created.
root['schemas']['Workstation']['properties']['deleteTime']['description']
new_valueOutput only. Time when this workstation was soft-deleted.
old_valueOutput only. Time when this resource was soft-deleted.
root['schemas']['Workstation']['properties']['displayName']['description']
new_valueOptional. Human-readable name for this workstation.
old_valueHuman-readable name for this resource.
root['schemas']['Workstation']['properties']['etag']['description']
new_valueOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
old_valueChecksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding.
root['schemas']['Workstation']['properties']['labels']['description']
new_valueOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.
old_valueClient-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.
root['schemas']['Workstation']['properties']['name']['description']
new_valueIdentifier. Full name of this workstation.
old_valueFull name of this resource.
root['schemas']['Workstation']['properties']['reconciling']['description']
new_valueOutput only. Indicates whether this workstation is currently being updated to match its intended state.
old_valueOutput only. Indicates whether this resource is currently being updated to match its intended state.
root['schemas']['Workstation']['properties']['uid']['description']
new_valueOutput only. A system-assigned unique identifier for this workstation.
old_valueOutput only. A system-assigned unique identified for this resource.
root['schemas']['Workstation']['properties']['updateTime']['description']
new_valueOutput only. Time when this workstation was most recently updated.
old_valueOutput only. Time when this resource was most recently updated.
root['schemas']['WorkstationCluster']['description']
new_valueA workstation cluster resource in the Cloud Workstations API. Defines a group of workstations in a particular region and the VPC network they're attached to.
old_valueA grouping of workstation configurations and the associated workstations in that region.
root['schemas']['WorkstationCluster']['properties']['annotations']['description']
new_valueOptional. Client-specified annotations.
old_valueClient-specified annotations.
root['schemas']['WorkstationCluster']['properties']['conditions']['description']
new_valueOutput only. Status conditions describing the workstation cluster's current state.
old_valueOutput only. Status conditions describing the current resource state.
root['schemas']['WorkstationCluster']['properties']['createTime']['description']
new_valueOutput only. Time when this workstation cluster was created.
old_valueOutput only. Time when this resource was created.
root['schemas']['WorkstationCluster']['properties']['degraded']['description']
new_valueOutput only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
old_valueOutput only. Whether this resource is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in the `conditions` field.
root['schemas']['WorkstationCluster']['properties']['deleteTime']['description']
new_valueOutput only. Time when this workstation cluster was soft-deleted.
old_valueOutput only. Time when this resource was soft-deleted.
root['schemas']['WorkstationCluster']['properties']['displayName']['description']
new_valueOptional. Human-readable name for this workstation cluster.
old_valueHuman-readable name for this resource.
root['schemas']['WorkstationCluster']['properties']['etag']['description']
new_valueOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
old_valueChecksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding.
root['schemas']['WorkstationCluster']['properties']['labels']['description']
new_valueOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
old_valueClient-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.
root['schemas']['WorkstationCluster']['properties']['name']['description']
new_valueIdentifier. Full name of this workstation cluster.
old_valueFull name of this resource.
root['schemas']['WorkstationCluster']['properties']['network']['description']
new_valueImmutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
old_valueImmutable. Name of the Compute Engine network in which instances associated with this cluster will be created.
root['schemas']['WorkstationCluster']['properties']['privateClusterConfig']['description']
new_valueOptional. Configuration for private workstation cluster.
old_valueConfiguration for private cluster.
root['schemas']['WorkstationCluster']['properties']['reconciling']['description']
new_valueOutput only. Indicates whether this workstation cluster is currently being updated to match its intended state.
old_valueOutput only. Indicates whether this resource is currently being updated to match its intended state.
root['schemas']['WorkstationCluster']['properties']['subnetwork']['description']
new_valueImmutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.
old_valueImmutable. Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. Must be part of the subnetwork specified for this cluster.
root['schemas']['WorkstationCluster']['properties']['uid']['description']
new_valueOutput only. A system-assigned unique identifier for this workstation cluster.
old_valueOutput only. A system-assigned unique identified for this resource.
root['schemas']['WorkstationCluster']['properties']['updateTime']['description']
new_valueOutput only. Time when this workstation cluster was most recently updated.
old_valueOutput only. Time when this resource was most recently updated.
root['schemas']['WorkstationConfig']['description']
new_valueA workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers.
old_valueA set of configuration options describing how a workstation will be run. Workstation configurations are intended to be shared across multiple workstations.
root['schemas']['WorkstationConfig']['properties']['annotations']['description']
new_valueOptional. Client-specified annotations.
old_valueClient-specified annotations.
root['schemas']['WorkstationConfig']['properties']['container']['description']
new_valueOptional. Container that runs upon startup for each workstation using this workstation configuration.
old_valueContainer that will be run for each workstation using this configuration when that workstation is started.
root['schemas']['WorkstationConfig']['properties']['createTime']['description']
new_valueOutput only. Time when this workstation configuration was created.
old_valueOutput only. Time when this resource was created.
root['schemas']['WorkstationConfig']['properties']['degraded']['description']
new_valueOutput only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
old_valueOutput only. Whether this resource is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in the `conditions` field.
root['schemas']['WorkstationConfig']['properties']['deleteTime']['description']
new_valueOutput only. Time when this workstation configuration was soft-deleted.
old_valueOutput only. Time when this resource was soft-deleted.
root['schemas']['WorkstationConfig']['properties']['displayName']['description']
new_valueOptional. Human-readable name for this workstation configuration.
old_valueHuman-readable name for this resource.
root['schemas']['WorkstationConfig']['properties']['encryptionKey']['description']
new_valueImmutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created.
old_valueEncrypts resources of this workstation configuration using a customer-managed encryption key. If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk will be lost. If the encryption key is revoked, the workstation session will automatically be stopped within 7 hours.
root['schemas']['WorkstationConfig']['properties']['etag']['description']
new_valueOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
old_valueChecksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding.
root['schemas']['WorkstationConfig']['properties']['host']['description']
new_valueOptional. Runtime host for the workstation.
old_valueRuntime host for the workstation.
root['schemas']['WorkstationConfig']['properties']['idleTimeout']['description']
new_valueOptional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes).
old_valueHow long to wait before automatically stopping an instance that hasn't received any user traffic. A value of 0 indicates that this instance should never time out due to idleness. Defaults to 20 minutes.
root['schemas']['WorkstationConfig']['properties']['labels']['description']
new_valueOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
old_valueClient-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources.
root['schemas']['WorkstationConfig']['properties']['name']['description']
new_valueIdentifier. Full name of this workstation configuration.
old_valueFull name of this resource.
root['schemas']['WorkstationConfig']['properties']['persistentDirectories']['description']
new_valueOptional. Directories to persist across workstation sessions.
old_valueDirectories to persist across workstation sessions.
root['schemas']['WorkstationConfig']['properties']['reconciling']['description']
new_valueOutput only. Indicates whether this workstation configuration is currently being updated to match its intended state.
old_valueOutput only. Indicates whether this resource is currently being updated to match its intended state.
root['schemas']['WorkstationConfig']['properties']['runningTimeout']['description']
new_valueOptional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.
old_valueHow long to wait before automatically stopping a workstation after it started. A value of 0 indicates that workstations using this configuration should never time out. Must be greater than 0 and less than 24 hours if encryption_key is set. Defaults to 12 hours.
root['schemas']['WorkstationConfig']['properties']['uid']['description']
new_valueOutput only. A system-assigned unique identifier for this workstation configuration.
old_valueOutput only. A system-assigned unique identified for this resource.
root['schemas']['WorkstationConfig']['properties']['updateTime']['description']
new_valueOutput only. Time when this workstation configuration was most recently updated.
old_valueOutput only. Time when this resource was most recently updated.
root['schemas']['GceRegionalPersistentDisk']['properties']['reclaimPolicy']['enumDescriptions'][2]
new_valueKeep the persistent disk when deleting the workstation. An administrator must manually delete the disk.
old_valueThe persistent disk will be remain after the workstation is deleted, and the administrator must manually delete the disk.
root['schemas']['GceRegionalPersistentDisk']['properties']['reclaimPolicy']['enumDescriptions'][1]
new_valueDelete the persistent disk when deleting the workstation.
old_valueThe persistent disk will be deleted with the workstation.
sandbox/beta-tasks-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/beta-tasks-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/content-autopush-apigee-
dictionary_item_added
  • root['schemas']['GoogleCloudApigeeV1Deployment']['description']
values_changed
root['resources']['organizations']['resources']['apiproducts']['methods']['attributes']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}`
root['resources']['organizations']['resources']['apiproducts']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['list']['description']
new_valueLists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.
root['resources']['organizations']['resources']['apiproducts']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the organization. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization. Use the following structure in your request: `organizations/{org}`
root['resources']['organizations']['resources']['apiproducts']['methods']['update']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path.To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['updateApiProductAttribute']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['delete']['parameters']['name']['description']
new_valueRequired. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization. If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization.
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['update']['parameters']['name']['description']
new_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apis']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the organization in the following format: `organizations/{org}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in the following format: `organizations/{org}`
root['resources']['organizations']['resources']['apis']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['methods']['list']['description']
new_valueLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.
root['resources']['organizations']['resources']['apis']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the organization in the following format: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in the following format: `organizations/{org}`
root['resources']['organizations']['resources']['apis']['methods']['patch']['parameters']['name']['description']
new_valueRequired. API proxy to update in the following format: `organizations/{org}/apis/{api}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy to update in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['delete']['parameters']['name']['description']
new_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['get']['parameters']['name']['description']
new_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['updateApiProxyRevision']['parameters']['name']['description']
new_valueRequired. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['deploy']['parameters']['name']['description']
new_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['getDeployments']['parameters']['name']['description']
new_valueRequired. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['undeploy']['parameters']['name']['description']
new_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['create']['parameters']['parent']['description']
new_valueRequired. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['deleteData']['parameters']['name']['description']
new_valueRequired. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['list']['parameters']['parent']['description']
new_valueRequired. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['resources']['data']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['deployments']['methods']['generateDeployChangeReport']['parameters']['name']['description']
new_valueName of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueName of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['deploy']['parameters']['name']['description']
new_valueRequired. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['getDeployments']['parameters']['name']['description']
new_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['undeploy']['parameters']['name']['description']
new_valueRequired. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['sharedflows']['methods']['create']['parameters']['parent']['description']
new_valueRequired. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['delete']['parameters']['name']['description']
new_valueRequired. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['list']['description']
new_valueLists all shared flows in the organization. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists all shared flows in the organization.
root['resources']['organizations']['resources']['sharedflows']['methods']['list']['parameters']['parent']['description']
new_valueRequired. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['delete']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['updateSharedFlowRevision']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`. If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`.
root['revision']
new_value20250220
old_value20250219
sandbox/content-autopush-apigee-v1
dictionary_item_added
  • root['schemas']['GoogleCloudApigeeV1Deployment']['description']
values_changed
root['resources']['organizations']['resources']['apiproducts']['methods']['attributes']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}`
root['resources']['organizations']['resources']['apiproducts']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['list']['description']
new_valueLists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.
root['resources']['organizations']['resources']['apiproducts']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the organization. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization. Use the following structure in your request: `organizations/{org}`
root['resources']['organizations']['resources']['apiproducts']['methods']['update']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path.To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['updateApiProductAttribute']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['delete']['parameters']['name']['description']
new_valueRequired. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization. If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization.
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['update']['parameters']['name']['description']
new_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apis']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the organization in the following format: `organizations/{org}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in the following format: `organizations/{org}`
root['resources']['organizations']['resources']['apis']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['methods']['list']['description']
new_valueLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.
root['resources']['organizations']['resources']['apis']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the organization in the following format: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in the following format: `organizations/{org}`
root['resources']['organizations']['resources']['apis']['methods']['patch']['parameters']['name']['description']
new_valueRequired. API proxy to update in the following format: `organizations/{org}/apis/{api}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy to update in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['delete']['parameters']['name']['description']
new_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['get']['parameters']['name']['description']
new_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['updateApiProxyRevision']['parameters']['name']['description']
new_valueRequired. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['deploy']['parameters']['name']['description']
new_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['getDeployments']['parameters']['name']['description']
new_valueRequired. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['undeploy']['parameters']['name']['description']
new_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['create']['parameters']['parent']['description']
new_valueRequired. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['deleteData']['parameters']['name']['description']
new_valueRequired. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['list']['parameters']['parent']['description']
new_valueRequired. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['resources']['data']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['deployments']['methods']['generateDeployChangeReport']['parameters']['name']['description']
new_valueName of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueName of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['deploy']['parameters']['name']['description']
new_valueRequired. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['getDeployments']['parameters']['name']['description']
new_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['undeploy']['parameters']['name']['description']
new_valueRequired. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['sharedflows']['methods']['create']['parameters']['parent']['description']
new_valueRequired. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['delete']['parameters']['name']['description']
new_valueRequired. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['list']['description']
new_valueLists all shared flows in the organization. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists all shared flows in the organization.
root['resources']['organizations']['resources']['sharedflows']['methods']['list']['parameters']['parent']['description']
new_valueRequired. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['delete']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['updateSharedFlowRevision']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`. If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`.
root['revision']
new_value20250220
old_value20250219
sandbox/content-autopush-automl-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-autopush-automl-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-autopush-automl-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-autopush-automl-v1p1beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-autopush-datamixer-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-autopush-datamixer-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-autopush-dlp-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/content-autopush-dlp-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/content-autopush-growth-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-autopush-growth-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-autopush-notifications-pa-
dictionary_item_added
  • root['schemas']['GoogleLogsTapandpayAndroid__PassesGeofencingEvent']
  • root['schemas']['WalletGooglepayCommon__IdCardCtaTarget']
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__PassTarget']['properties']['attachmentIndex']
  • root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['properties']['passesGeofencingEvent']
  • root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['properties']['isWearAppInBackground']
  • root['schemas']['WalletGooglepayCommon__MdocUnderReviewTarget']['properties']['screenType']
  • root['schemas']['WalletGooglepayCommon__NavigationTarget']['properties']['idCardCta']
dictionary_item_removed
  • root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['properties']['isAppInBackground']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleInternalTapandpayV1PassesTemplates__PassTarget']['description']
new_valueAn action to take that is related to a specific pass. Objects that contain a target that is unrecognized or that is not known how to be handled by the current client version should hide the object instead of showing it. Next ID: 12
old_valueAn action to take that is related to a specific pass. Objects that contain a target that is unrecognized or that is not known how to be handled by the current client version should hide the object instead of showing it. Next ID: 11
root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['description']
new_valueTop-level extension to be reported Next id: 209
old_valueTop-level extension to be reported Next id: 208
root['schemas']['WalletGooglepayCommon__MdocUnderReviewTarget']['description']
new_valueA target to intent to the mdoc under review screen. Next id: 4
old_valueA target to intent to the mdoc under review screen. Next id: 3
root['schemas']['WalletGooglepayCommon__NavigationTarget']['description']
new_valueThe target to navigate to. A target should be a pure navigation target. I.e. the target should not represent an action to be taken (besides navigation). Next id: 73
old_valueThe target to navigate to. A target should be a pure navigation target. I.e. the target should not represent an action to be taken (besides navigation). Next id: 72
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__BackupRestoreEvent']['properties']['errorType']['enum'][9]NO_DATA_TO_RESTORE
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][211]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_ATTEMPT
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][212]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_LOCK_ACQUIRED
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][213]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_LOCK_CONTENTION_RESCHEDULE_NEEDED
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][214]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_LOCK_CONTENTION_RESCHEDULE_NOT_NEEDED
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][211]Events for collecting and analyzing lock contention during checking and updating bundles with ClosedLoopBundleManager. Event for when a bundle check is attempted.
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][212]Event for when the lock is successfully acquired.
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][213]Event for when the lock contention is detected and bundle check reschedule is needed.
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][214]Event for when the lock contention is detected but bundle check reschedule is not needed.
sandbox/content-autopush-notifications-pa-v1
dictionary_item_added
  • root['schemas']['GoogleLogsTapandpayAndroid__PassesGeofencingEvent']
  • root['schemas']['WalletGooglepayCommon__IdCardCtaTarget']
  • root['schemas']['GoogleInternalTapandpayV1PassesTemplates__PassTarget']['properties']['attachmentIndex']
  • root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['properties']['passesGeofencingEvent']
  • root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['properties']['isWearAppInBackground']
  • root['schemas']['WalletGooglepayCommon__MdocUnderReviewTarget']['properties']['screenType']
  • root['schemas']['WalletGooglepayCommon__NavigationTarget']['properties']['idCardCta']
dictionary_item_removed
  • root['schemas']['GoogleLogsTapandpayAndroid__TransitHceSessionEvent']['properties']['isAppInBackground']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleInternalTapandpayV1PassesTemplates__PassTarget']['description']
new_valueAn action to take that is related to a specific pass. Objects that contain a target that is unrecognized or that is not known how to be handled by the current client version should hide the object instead of showing it. Next ID: 12
old_valueAn action to take that is related to a specific pass. Objects that contain a target that is unrecognized or that is not known how to be handled by the current client version should hide the object instead of showing it. Next ID: 11
root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['description']
new_valueTop-level extension to be reported Next id: 209
old_valueTop-level extension to be reported Next id: 208
root['schemas']['WalletGooglepayCommon__MdocUnderReviewTarget']['description']
new_valueA target to intent to the mdoc under review screen. Next id: 4
old_valueA target to intent to the mdoc under review screen. Next id: 3
root['schemas']['WalletGooglepayCommon__NavigationTarget']['description']
new_valueThe target to navigate to. A target should be a pure navigation target. I.e. the target should not represent an action to be taken (besides navigation). Next id: 73
old_valueThe target to navigate to. A target should be a pure navigation target. I.e. the target should not represent an action to be taken (besides navigation). Next id: 72
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__BackupRestoreEvent']['properties']['errorType']['enum'][9]NO_DATA_TO_RESTORE
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][211]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_ATTEMPT
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][212]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_LOCK_ACQUIRED
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][213]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_LOCK_CONTENTION_RESCHEDULE_NEEDED
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enum'][214]BUNDLE_MANAGER_CHECK_AND_UPDATE_BUNDLES_LOCK_CONTENTION_RESCHEDULE_NOT_NEEDED
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][211]Events for collecting and analyzing lock contention during checking and updating bundles with ClosedLoopBundleManager. Event for when a bundle check is attempted.
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][212]Event for when the lock is successfully acquired.
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][213]Event for when the lock contention is detected and bundle check reschedule is needed.
root['schemas']['GoogleLogsTapandpayAndroid__ClosedLoopEvent']['properties']['eventType']['enumDescriptions'][214]Event for when the lock contention is detected but bundle check reschedule is not needed.
sandbox/content-daily-cloudsearch-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/content-daily-cloudsearch-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/content-hourly-dynamicmail-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-hourly-dynamicmail-pa-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-qa-alkalimetricsink-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/content-qa-alkalimetricsink-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/content-qa-binaryauthorization-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-qa-binaryauthorization-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-qa-binaryauthorization-v1alpha2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-qa-binaryauthorization-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-staging-binaryauthorization-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-staging-binaryauthorization-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-staging-binaryauthorization-v1alpha2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-staging-binaryauthorization-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-staging-firebase-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/content-staging-firebase-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/content-staging-firebase-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/content-staging-firebase-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/content-test-redis-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-test-redis-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-test-redis-v1alpha1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-test-redis-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-test-redis-v1internal1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-test-translate-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-test-translate-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-test-translate-v3
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-test-translate-v3alpha1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/content-test-translate-v3beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/daily-cloudsearch-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/daily-cloudsearch-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/daily-dataflowbackend-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/daily-dataflowbackend-pa-v1b3
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/daily-firebaseml-
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['description']
new_valueRetrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder
old_valueRetrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder
root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['properties']['datastore']['description']
new_valueOptional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
old_valueRequired. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
sandbox/daily-firebaseml-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/daily-firebaseml-v1beta2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/daily-firebaseml-v2beta
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['description']
new_valueRetrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder
old_valueRetrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder
root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['properties']['datastore']['description']
new_valueOptional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
old_valueRequired. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
sandbox/daily-mlkit-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/daily-mlkit-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/daily-serviceconsumermanagement-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/daily-serviceconsumermanagement-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/daily-serviceconsumermanagement-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/daily-serviceconsumermanagement-v1alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/daily-serviceconsumermanagement-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/daily-serviceconsumermanagement-v2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/daily-servicenetworking-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/daily-servicenetworking-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/daily-servicenetworking-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/daily3-emmapplecodevice-
values_changed
root['revision']
new_value20250219
old_value20250212
sandbox/daily3-emmapplecodevice-v1
values_changed
root['revision']
new_value20250219
old_value20250212
sandbox/dataflow-staging-
values_changed
root['revision']
new_value20250219
old_value20250215
sandbox/dataflow-staging-v1b3
values_changed
root['revision']
new_value20250219
old_value20250215
sandbox/dev-dialogflow-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/dev-dialogflow-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/dev-dialogflow-v2
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/dev-dialogflow-v2beta1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/dev-dialogflow-v3
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/dev-dialogflow-v3alpha1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/dev-dialogflow-v3beta1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/dev-scone-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
iterable_item_added
root['schemas']['CustomerSupportContentContactFlowModel']['properties']['contactFlowType']['enum'][13]MOSP
root['schemas']['CustomerSupportContentContactFlowModel']['properties']['contactFlowType']['enumDescriptions'][13]Submission via MOSP.
root['schemas']['CustomerSupportContentContactForm']['properties']['connectorType']['enum'][13]MOSP
root['schemas']['CustomerSupportContentContactForm']['properties']['connectorType']['enumDescriptions'][13]Submission via MOSP.
sandbox/dev-scone-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
iterable_item_added
root['schemas']['CustomerSupportContentContactFlowModel']['properties']['contactFlowType']['enum'][13]MOSP
root['schemas']['CustomerSupportContentContactFlowModel']['properties']['contactFlowType']['enumDescriptions'][13]Submission via MOSP.
root['schemas']['CustomerSupportContentContactForm']['properties']['connectorType']['enum'][13]MOSP
root['schemas']['CustomerSupportContentContactForm']['properties']['connectorType']['enumDescriptions'][13]Submission via MOSP.
sandbox/dev-us-central1-dialogflow-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/dev-us-central1-dialogflow-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/dev-us-central1-dialogflow-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/dev-us-central1-dialogflow-v2beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/dev-us-central1-dialogflow-v3
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/dev-us-central1-dialogflow-v3alpha1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/dev-us-central1-dialogflow-v3beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/devel-language-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/devel-language-eu-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/devel-language-eu-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/devel-language-eu-v1beta2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/devel-language-eu-v2
values_changed
root['revision']
new_value20250220
old_value20250216
sandbox/devel-language-us-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/devel-language-us-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/devel-language-us-v1beta2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/devel-language-us-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/devel-language-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/devel-language-v1beta2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/devel-language-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/eu-autopush-automl-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/eu-autopush-automl-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/eu-autopush-automl-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/eu-autopush-automl-v1p1beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/eu-staging-datacatalog-
values_changed
root['revision']
new_value20250219
old_value20250216
sandbox/eu-staging-datacatalog-v1
values_changed
root['revision']
new_value20250219
old_value20250216
sandbox/eu-staging-datacatalog-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250216
sandbox/eu-staging-vision-
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/eu-staging-vision-v1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/eu-staging-vision-v1p1beta1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/eu-staging-vision-v1p2beta1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/eu-staging-vision-v1p3beta1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/eu-staging-vision-v1p4beta1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/hourly-dynamicmail-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/hourly-dynamicmail-pa-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/nightly-alkalibasemap-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/nightly-alkalibasemap-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/nightly-alkalimetricsink-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/nightly-alkalimetricsink-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/ppissuer-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/ppissuer-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/preprod-firebaseremoteconfig-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/preprod-firebaseremoteconfig-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/preprod-firebaseremoteconfig-pa-v2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/preprod-growth-pa-
dictionary_item_added
  • root['schemas']['InAppBrowserRedirectData']
  • root['schemas']['CustomAction']['properties']['inAppBrowserRedirect']
values_changed
root['revision']
new_value20250219
old_value20250217
sandbox/preprod-growth-pa-v1
dictionary_item_added
  • root['schemas']['InAppBrowserRedirectData']
  • root['schemas']['CustomAction']['properties']['inAppBrowserRedirect']
values_changed
root['revision']
new_value20250219
old_value20250217
sandbox/preprod-hangouts-
values_changed
root['revision']
new_value20250219
old_value20250217
sandbox/preprod-hangouts-v1
values_changed
root['revision']
new_value20250219
old_value20250217
sandbox/preprod-rsvp-
dictionary_item_added
  • root['resources']['users']['methods']['get']['deprecated']
  • root['schemas']['GoogleAppsRsvpV1HydrateSiteGuestResponse']['properties']['redirectUri']
dictionary_item_removed
  • root['schemas']['GoogleAppsRsvpV1HydrateSiteGuestResponse']['properties']['enableGuestContactsCc']
  • root['schemas']['GoogleAppsRsvpV1HydrateSiteGuestResponse']['properties']['subscribers']
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleAppsRsvpV1Team']['properties']['publishingPermission']['description']
new_valueOptional. The publishing permission setting for this event.
old_valueOptional. Defines who on the team can publish event data.
root['schemas']['GoogleAppsRsvpV1Team']['properties']['publishingPermission']['enumDescriptions'][1]
new_valueUsers can publish any linked Event they have a WRITER ACL entry on.
old_valueEvent Admins.
root['schemas']['GoogleAppsRsvpV1Team']['properties']['publishingPermission']['enumDescriptions'][0]
new_valueUsers can publish any Event they have a WRITER ACL entry on.
old_valueDefault (unspecified) publishing permission.
root['schemas']['GoogleAppsRsvpV1Team']['properties']['publishingPermission']['enumDescriptions'][2]
new_valueOnly users with an OWNER ACL entry on the team can publish linked Events.
old_valueTeam Admins only.
sandbox/preprod-rsvp-v1
dictionary_item_added
  • root['resources']['users']['methods']['get']['deprecated']
  • root['schemas']['GoogleAppsRsvpV1HydrateSiteGuestResponse']['properties']['redirectUri']
dictionary_item_removed
  • root['schemas']['GoogleAppsRsvpV1HydrateSiteGuestResponse']['properties']['enableGuestContactsCc']
  • root['schemas']['GoogleAppsRsvpV1HydrateSiteGuestResponse']['properties']['subscribers']
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleAppsRsvpV1Team']['properties']['publishingPermission']['description']
new_valueOptional. The publishing permission setting for this event.
old_valueOptional. Defines who on the team can publish event data.
root['schemas']['GoogleAppsRsvpV1Team']['properties']['publishingPermission']['enumDescriptions'][1]
new_valueUsers can publish any linked Event they have a WRITER ACL entry on.
old_valueEvent Admins.
root['schemas']['GoogleAppsRsvpV1Team']['properties']['publishingPermission']['enumDescriptions'][0]
new_valueUsers can publish any Event they have a WRITER ACL entry on.
old_valueDefault (unspecified) publishing permission.
root['schemas']['GoogleAppsRsvpV1Team']['properties']['publishingPermission']['enumDescriptions'][2]
new_valueOnly users with an OWNER ACL entry on the team can publish linked Events.
old_valueTeam Admins only.
sandbox/qa-alkalimetricsink-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/qa-alkalimetricsink-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/qa-alkalitermsofservice-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/qa-alkalitermsofservice-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/qa-binaryauthorization-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/qa-binaryauthorization-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/qa-binaryauthorization-v1alpha2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/qa-binaryauthorization-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-actions-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-actions-v2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-actions-v2alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-actions-v3
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-adsmarketingfrontend-pa-
dictionary_item_added
  • root['resources']['optimization']['methods']['globalOptimize']
  • root['schemas']['GeoLevelConstraint']
  • root['schemas']['GlobalOptimizeRequest']
  • root['schemas']['GlobalOptimizeResponse']
  • root['schemas']['GlobalOptimizedBudget']
  • root['schemas']['RowLevelConstraint']['properties']['subregion']
values_changed
root['resources']['optimization']['methods']['optimize']['description']
new_valueEntry point to the within-country optimization service. See go/ce-mp-optimization-strategy for more details.
old_valueEntry point into the optimization service.
root['revision']
new_value20250219
old_value20250218
root['schemas']['OptimizeRequest']['description']
new_valueInput necessary to perform within-country paid media budget optimization between channels for the Yosemite project. See go/ce-mp-optimization-strategy for more details.
old_valueInput necessary to perform paid media budget optimization between channels for the Yosemite project. See go/ce-mp-optimization-strategy for more details.
root['schemas']['OptimizeResponse']['description']
new_valueYosemite within-country optimization output. See go/ce-mp-optimization-strategy for more details.
old_valueYosemite optimization output. See go/ce-mp-optimization-strategy for more details.
sandbox/staging-adsmarketingfrontend-pa-v1
dictionary_item_added
  • root['resources']['optimization']['methods']['globalOptimize']
  • root['schemas']['GeoLevelConstraint']
  • root['schemas']['GlobalOptimizeRequest']
  • root['schemas']['GlobalOptimizeResponse']
  • root['schemas']['GlobalOptimizedBudget']
  • root['schemas']['RowLevelConstraint']['properties']['subregion']
values_changed
root['resources']['optimization']['methods']['optimize']['description']
new_valueEntry point to the within-country optimization service. See go/ce-mp-optimization-strategy for more details.
old_valueEntry point into the optimization service.
root['revision']
new_value20250219
old_value20250218
root['schemas']['OptimizeRequest']['description']
new_valueInput necessary to perform within-country paid media budget optimization between channels for the Yosemite project. See go/ce-mp-optimization-strategy for more details.
old_valueInput necessary to perform paid media budget optimization between channels for the Yosemite project. See go/ce-mp-optimization-strategy for more details.
root['schemas']['OptimizeResponse']['description']
new_valueYosemite within-country optimization output. See go/ce-mp-optimization-strategy for more details.
old_valueYosemite optimization output. See go/ce-mp-optimization-strategy for more details.
sandbox/staging-aerialview-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-aerialview-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-aerialview-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-aiplatform-
dictionary_item_added
  • root['schemas']['GoogleCloudAiplatformV1beta1DeployRequestCustomModel']
  • root['schemas']['GoogleCloudAiplatformV1beta1DeployRequest']['properties']['customModel']
  • root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['properties']['engine']
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleCloudAiplatformV1beta1NearestNeighborQueryRawText']['properties']['embeddingModelName']['description']
new_valueOptional. The embedding model name.
old_valueOptional. The embedding model name. This field is not yet implemented (b/394896477)
root['schemas']['GoogleCloudAiplatformV1beta1NearestNeighborQueryRawText']['properties']['taskType']['description']
new_valueOptional. Represents a downstream task the embeddings will be used for.
old_valueOptional. Represents a downstream task the embeddings will be used for. This field is not yet implemented (b/subtype1)
root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['description']
new_valueRetrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder
old_valueRetrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder
root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['properties']['datastore']['description']
new_valueOptional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
old_valueRequired. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
sandbox/staging-aiplatform-v1
dictionary_item_added
  • root['schemas']['GoogleCloudAiplatformV1VertexAISearch']['properties']['engine']
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleCloudAiplatformV1NearestNeighborQueryRawText']['properties']['embeddingModelName']['description']
new_valueOptional. The embedding model name.
old_valueOptional. The embedding model name. This field is not yet implemented (b/394896477)
root['schemas']['GoogleCloudAiplatformV1NearestNeighborQueryRawText']['properties']['taskType']['description']
new_valueOptional. Represents a downstream task the embeddings will be used for.
old_valueOptional. Represents a downstream task the embeddings will be used for. This field is not yet implemented (b/subtype1)
root['schemas']['GoogleCloudAiplatformV1VertexAISearch']['description']
new_valueRetrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder
old_valueRetrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder
root['schemas']['GoogleCloudAiplatformV1VertexAISearch']['properties']['datastore']['description']
new_valueOptional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
old_valueRequired. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
sandbox/staging-aiplatform-v1alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-aiplatform-v1beta1
dictionary_item_added
  • root['schemas']['GoogleCloudAiplatformV1beta1DeployRequestCustomModel']
  • root['schemas']['GoogleCloudAiplatformV1beta1DeployRequest']['properties']['customModel']
  • root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['properties']['engine']
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleCloudAiplatformV1beta1NearestNeighborQueryRawText']['properties']['embeddingModelName']['description']
new_valueOptional. The embedding model name.
old_valueOptional. The embedding model name. This field is not yet implemented (b/394896477)
root['schemas']['GoogleCloudAiplatformV1beta1NearestNeighborQueryRawText']['properties']['taskType']['description']
new_valueOptional. Represents a downstream task the embeddings will be used for.
old_valueOptional. Represents a downstream task the embeddings will be used for. This field is not yet implemented (b/subtype1)
root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['description']
new_valueRetrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder
old_valueRetrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder
root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['properties']['datastore']['description']
new_valueOptional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
old_valueRequired. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
sandbox/staging-analyticsdata-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-analyticsdata-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-analyticsdata-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-analyticsdata-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-analyticssuitefrontend-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-analyticssuitefrontend-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-apigee-
dictionary_item_added
  • root['schemas']['GoogleCloudApigeeV1Deployment']['description']
values_changed
root['resources']['organizations']['resources']['apiproducts']['methods']['attributes']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}`
root['resources']['organizations']['resources']['apiproducts']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['list']['description']
new_valueLists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.
root['resources']['organizations']['resources']['apiproducts']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the organization. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization. Use the following structure in your request: `organizations/{org}`
root['resources']['organizations']['resources']['apiproducts']['methods']['update']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path.To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['updateApiProductAttribute']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['delete']['parameters']['name']['description']
new_valueRequired. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization. If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization.
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['update']['parameters']['name']['description']
new_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apis']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the organization in the following format: `organizations/{org}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in the following format: `organizations/{org}`
root['resources']['organizations']['resources']['apis']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['methods']['list']['description']
new_valueLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.
root['resources']['organizations']['resources']['apis']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the organization in the following format: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in the following format: `organizations/{org}`
root['resources']['organizations']['resources']['apis']['methods']['patch']['parameters']['name']['description']
new_valueRequired. API proxy to update in the following format: `organizations/{org}/apis/{api}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy to update in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['delete']['parameters']['name']['description']
new_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['get']['parameters']['name']['description']
new_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['updateApiProxyRevision']['parameters']['name']['description']
new_valueRequired. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['deploy']['parameters']['name']['description']
new_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['getDeployments']['parameters']['name']['description']
new_valueRequired. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['undeploy']['parameters']['name']['description']
new_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['create']['parameters']['parent']['description']
new_valueRequired. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['deleteData']['parameters']['name']['description']
new_valueRequired. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['list']['parameters']['parent']['description']
new_valueRequired. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['resources']['data']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['deployments']['methods']['generateDeployChangeReport']['parameters']['name']['description']
new_valueName of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueName of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['deploy']['parameters']['name']['description']
new_valueRequired. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['getDeployments']['parameters']['name']['description']
new_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['undeploy']['parameters']['name']['description']
new_valueRequired. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['sharedflows']['methods']['create']['parameters']['parent']['description']
new_valueRequired. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['delete']['parameters']['name']['description']
new_valueRequired. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['list']['description']
new_valueLists all shared flows in the organization. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists all shared flows in the organization.
root['resources']['organizations']['resources']['sharedflows']['methods']['list']['parameters']['parent']['description']
new_valueRequired. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['delete']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['updateSharedFlowRevision']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`. If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`.
root['revision']
new_value20250220
old_value20250218
sandbox/staging-apigee-v1
dictionary_item_added
  • root['schemas']['GoogleCloudApigeeV1Deployment']['description']
values_changed
root['resources']['organizations']['resources']['apiproducts']['methods']['attributes']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in which the API product will be created. Use the following structure in your request: `organizations/{org}`
root['resources']['organizations']['resources']['apiproducts']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['methods']['list']['description']
new_valueLists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists all API product names for an organization. Filter the list by passing an `attributename` and `attibutevalue`. The maximum number of API products returned is 1000. You can paginate the list of API products returned using the `startKey` and `count` query parameters.
root['resources']['organizations']['resources']['apiproducts']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the organization. Use the following structure in your request: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization. Use the following structure in your request: `organizations/{org}`
root['resources']['organizations']['resources']['apiproducts']['methods']['update']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path.To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product attribute. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/attributes/{attribute}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['attributes']['methods']['updateApiProductAttribute']['parameters']['name']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product that is associated with the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['delete']['parameters']['name']['description']
new_valueRequired. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. ID of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization. If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API product. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}` Use `organizations/{org}/apiproducts/-` to return rate plans for all API products within the organization.
root['resources']['organizations']['resources']['apiproducts']['resources']['rateplans']['methods']['update']['parameters']['name']['description']
new_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}` If the API Product resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the rate plan. Use the following structure in your request: `organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}`
root['resources']['organizations']['resources']['apis']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the organization in the following format: `organizations/{org}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in the following format: `organizations/{org}`
root['resources']['organizations']['resources']['apis']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['methods']['get']['parameters']['name']['description']
new_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['methods']['list']['description']
new_valueLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy.
root['resources']['organizations']['resources']['apis']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the organization in the following format: `organizations/{org}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the organization in the following format: `organizations/{org}`
root['resources']['organizations']['resources']['apis']['methods']['patch']['parameters']['name']['description']
new_valueRequired. API proxy to update in the following format: `organizations/{org}/apis/{api}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy to update in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy for which to return deployment information in the following format: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}`
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['delete']['parameters']['name']['description']
new_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['get']['parameters']['name']['description']
new_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['methods']['updateApiProxyRevision']['parameters']['name']['description']
new_valueRequired. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` If the API Proxy resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. API proxy revision to update in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['apis']['resources']['revisions']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing an API proxy in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['deploy']['parameters']['name']['description']
new_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['getDeployments']['parameters']['name']['description']
new_valueRequired. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing an API proxy revision in an environment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['methods']['undeploy']['parameters']['name']['description']
new_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['create']['parameters']['parent']['description']
new_valueRequired. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The resource name of the API Proxy revision deployment for which to create the DebugSession. Must be of the form `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['deleteData']['parameters']['name']['description']
new_valueRequired. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session to delete. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{debugsession}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session to retrieve. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['methods']['list']['parameters']['parent']['description']
new_valueRequired. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the API Proxy revision deployment for which to list debug sessions. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['debugsessions']['resources']['data']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`. If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the debug session transaction. Must be of the form: `organizations/{organization}/environments/{environment}/apis/{api}/revisions/{revision}/debugsessions/{session}/data/{transaction}`.
root['resources']['organizations']['resources']['environments']['resources']['apis']['resources']['revisions']['resources']['deployments']['methods']['generateDeployChangeReport']['parameters']['name']['description']
new_valueName of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}` If the API proxy resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueName of the API proxy revision deployment in the following format: `organizations/{org}/environments/{env}/apis/{api}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['deploy']['parameters']['name']['description']
new_valueRequired. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource being deployed has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow revision to deploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['getDeployments']['parameters']['name']['description']
new_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name representing a shared flow in an environment in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['environments']['resources']['sharedflows']['resources']['revisions']['methods']['undeploy']['parameters']['name']['description']
new_valueRequired. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow revision to undeploy in the following format: `organizations/{org}/environments/{env}/sharedflows/{sharedflow}/revisions/{rev}`
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['create']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['delete']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to delete the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['get']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to fetch the key value map entry/value. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to list key value maps. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['keyvaluemaps']['resources']['entries']['methods']['update']['parameters']['name']['description']
new_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Scope as indicated by the URI in which to create the key value map entry. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`.
root['resources']['organizations']['resources']['sharedflows']['methods']['create']['parameters']['parent']['description']
new_valueRequired. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the parent organization under which to create the shared flow. Must be of the form: `organizations/{organization_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['delete']['parameters']['name']['description']
new_valueRequired. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. shared flow name of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}`
root['resources']['organizations']['resources']['sharedflows']['methods']['list']['description']
new_valueLists all shared flows in the organization. If the resource has the `space` attribute set, the response may not return all resources. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueLists all shared flows in the organization.
root['resources']['organizations']['resources']['sharedflows']['methods']['list']['parameters']['parent']['description']
new_valueRequired. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the parent organization under which to get shared flows. Must be of the form: `organizations/{organization_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}` If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the shared flow for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['delete']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to delete. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['get']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the Shared Flow resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to get. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['methods']['updateSharedFlowRevision']['parameters']['name']['description']
new_valueRequired. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}` If the resource has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. The name of the shared flow revision to update. Must be of the form: `organizations/{organization_id}/sharedflows/{shared_flow_id}/revisions/{revision_id}`
root['resources']['organizations']['resources']['sharedflows']['resources']['revisions']['resources']['deployments']['methods']['list']['parameters']['parent']['description']
new_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`. If the shared flow resource has the `space` attribute set, IAM permissions are checked differently . To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).
old_valueRequired. Name of the API proxy revision for which to return deployment information in the following format: `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}`.
root['revision']
new_value20250220
old_value20250218
sandbox/staging-appsgenaiserver-pa-
dictionary_item_added
  • root['schemas']['AppsIntelligenceGenAiHelpMeOrganizeUseCaseParams']
  • root['schemas']['AppsIntelligenceGenAiUseCaseParams']['properties']['helpMeOrganizeUseCaseParams']
  • root['schemas']['AppsUpsellSharedRecommendationTemplatesBanner']['properties']['bannerSize']
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['AppsIntelligenceGenAiUseCaseParams']['description']
new_valueGenerate Use Case specific parameters Next ID: 12.
old_valueGenerate Use Case specific parameters Next ID: 11.
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][397]
new_valueCOMMERCE_BUYFLOW_CONVERT_TO_FREE
old_valueCOMMERCE_BUYFLOW_EDIT_CART
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][396]
new_valueCOMMERCE_BUYFLOW_DECREASE_COMMITMENT
old_valueCOMMERCE_BUYFLOW_REVIEW_CART
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][397]
new_valueCOMMERCE_BUYFLOW_CONVERT_TO_FREE
old_valueCOMMERCE_BUYFLOW_EDIT_CART
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enumDescriptions'][390]
new_valuego/monetization-sources Important commerce order types. For description of each order type, see //depot/google3/ccc/hosted/commerce/proto/schema.proto?q=symbol:CartProto.LineItem.OrderType
old_valuego/monetization-sources Important commerce Buyflow journeys (aka Buyflow actions)
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][393]
new_valueCOMMERCE_BUYFLOW_CONTRACT_OFFER_SWITCH
old_valueCOMMERCE_BUYFLOW_CHANGE_PLAN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][395]
new_valueCOMMERCE_BUYFLOW_CURRENCY_SWITCH
old_valueCOMMERCE_BUYFLOW_SWITCH_CURRENCY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][395]
new_valueCOMMERCE_BUYFLOW_CURRENCY_SWITCH
old_valueCOMMERCE_BUYFLOW_SWITCH_CURRENCY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][396]
new_valueCOMMERCE_BUYFLOW_DECREASE_COMMITMENT
old_valueCOMMERCE_BUYFLOW_REVIEW_CART
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][398]
new_valueCOMMERCE_BUYFLOW_SWITCH_TO_INTERNAL_GOOGLER_OFFER
old_valueCOMMERCE_BUYFLOW_REVIEW_PROPOSAL
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enumDescriptions'][390]
new_valuego/monetization-sources Important commerce order types. For description of each order type, see //depot/google3/ccc/hosted/commerce/proto/schema.proto?q=symbol:CartProto.LineItem.OrderType
old_valuego/monetization-sources Important commerce Buyflow journeys (aka Buyflow actions)
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][393]
new_valueCOMMERCE_BUYFLOW_CONTRACT_OFFER_SWITCH
old_valueCOMMERCE_BUYFLOW_CHANGE_PLAN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][398]
new_valueCOMMERCE_BUYFLOW_SWITCH_TO_INTERNAL_GOOGLER_OFFER
old_valueCOMMERCE_BUYFLOW_REVIEW_PROPOSAL
iterable_item_added
root['schemas']['AppsIntelligenceGenAiGenerateStatusResponse']['properties']['status']['enum'][26]STATUS_ALS_STATE_GENERATING_IMAGES
root['schemas']['AppsIntelligenceGenAiGenerateStatusResponse']['properties']['status']['enumDescriptions'][26]Status when an image generation starts.
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][418]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][428]PMAX_GWS_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][482]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][418]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][428]PMAX_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][482]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoTemplateId']['enum'][173]SECURITY_INSIGHTS_PHISHING_MALWARE_CARD_FRIENDLY_BUYFLOW
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][400]COMMERCE_BUYFLOW_SCHEDULE_SWITCH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][401]COMMERCE_BUYFLOW_UNCATEGORIZED
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][418]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][428]PMAX_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][482]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][400]COMMERCE_BUYFLOW_SCHEDULE_SWITCH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][401]COMMERCE_BUYFLOW_UNCATEGORIZED
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][418]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][428]PMAX_GWS_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][482]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOVN
sandbox/staging-appsgenaiserver-pa-v1
dictionary_item_added
  • root['schemas']['AppsIntelligenceGenAiHelpMeOrganizeUseCaseParams']
  • root['schemas']['AppsIntelligenceGenAiUseCaseParams']['properties']['helpMeOrganizeUseCaseParams']
  • root['schemas']['AppsUpsellSharedRecommendationTemplatesBanner']['properties']['bannerSize']
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['AppsIntelligenceGenAiUseCaseParams']['description']
new_valueGenerate Use Case specific parameters Next ID: 12.
old_valueGenerate Use Case specific parameters Next ID: 11.
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][397]
new_valueCOMMERCE_BUYFLOW_CONVERT_TO_FREE
old_valueCOMMERCE_BUYFLOW_EDIT_CART
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][396]
new_valueCOMMERCE_BUYFLOW_DECREASE_COMMITMENT
old_valueCOMMERCE_BUYFLOW_REVIEW_CART
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][397]
new_valueCOMMERCE_BUYFLOW_CONVERT_TO_FREE
old_valueCOMMERCE_BUYFLOW_EDIT_CART
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enumDescriptions'][390]
new_valuego/monetization-sources Important commerce order types. For description of each order type, see //depot/google3/ccc/hosted/commerce/proto/schema.proto?q=symbol:CartProto.LineItem.OrderType
old_valuego/monetization-sources Important commerce Buyflow journeys (aka Buyflow actions)
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][393]
new_valueCOMMERCE_BUYFLOW_CONTRACT_OFFER_SWITCH
old_valueCOMMERCE_BUYFLOW_CHANGE_PLAN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][395]
new_valueCOMMERCE_BUYFLOW_CURRENCY_SWITCH
old_valueCOMMERCE_BUYFLOW_SWITCH_CURRENCY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][395]
new_valueCOMMERCE_BUYFLOW_CURRENCY_SWITCH
old_valueCOMMERCE_BUYFLOW_SWITCH_CURRENCY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][396]
new_valueCOMMERCE_BUYFLOW_DECREASE_COMMITMENT
old_valueCOMMERCE_BUYFLOW_REVIEW_CART
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][398]
new_valueCOMMERCE_BUYFLOW_SWITCH_TO_INTERNAL_GOOGLER_OFFER
old_valueCOMMERCE_BUYFLOW_REVIEW_PROPOSAL
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enumDescriptions'][390]
new_valuego/monetization-sources Important commerce order types. For description of each order type, see //depot/google3/ccc/hosted/commerce/proto/schema.proto?q=symbol:CartProto.LineItem.OrderType
old_valuego/monetization-sources Important commerce Buyflow journeys (aka Buyflow actions)
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][393]
new_valueCOMMERCE_BUYFLOW_CONTRACT_OFFER_SWITCH
old_valueCOMMERCE_BUYFLOW_CHANGE_PLAN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][398]
new_valueCOMMERCE_BUYFLOW_SWITCH_TO_INTERNAL_GOOGLER_OFFER
old_valueCOMMERCE_BUYFLOW_REVIEW_PROPOSAL
iterable_item_added
root['schemas']['AppsIntelligenceGenAiGenerateStatusResponse']['properties']['status']['enum'][26]STATUS_ALS_STATE_GENERATING_IMAGES
root['schemas']['AppsIntelligenceGenAiGenerateStatusResponse']['properties']['status']['enumDescriptions'][26]Status when an image generation starts.
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][418]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][428]PMAX_GWS_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOVN
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][482]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOID
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['AppsUpsellSharedRecommendationRecommendationSurface']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][418]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][428]PMAX_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][482]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoTemplateId']['enum'][173]SECURITY_INSIGHTS_PHISHING_MALWARE_CARD_FRIENDLY_BUYFLOW
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][400]COMMERCE_BUYFLOW_SCHEDULE_SWITCH
root['schemas']['CccHostedUpsellProtoEventsDerivedRecommendationInteractionDetails']['properties']['promoType']['enum'][401]COMMERCE_BUYFLOW_UNCATEGORIZED
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][418]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][428]PMAX_GWS_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][482]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOID
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOVN
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][400]COMMERCE_BUYFLOW_SCHEDULE_SWITCH
root['schemas']['CccHostedUpsellProtoSourceAttributionSource']['properties']['promoType']['enum'][401]COMMERCE_BUYFLOW_UNCATEGORIZED
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][56]DG_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][57]DG_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][58]DG_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][59]DG_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][60]DG_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][61]DG_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][62]DG_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][63]DG_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][64]DG_GEMINI_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][68]DG_GWS_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][69]DG_GWS_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][70]DG_GWS_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][71]DG_GWS_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][72]DG_GWS_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][73]DG_GWS_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][74]DG_GWS_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][75]DG_GWS_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][76]DG_GWS_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][156]GDN_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][157]GDN_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][158]GDN_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][159]GDN_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][160]GDN_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][161]GDN_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][162]GDN_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][163]GDN_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][164]GDN_GEMINI_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][168]GDN_GWS_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][169]GDN_GWS_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][170]GDN_GWS_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][171]GDN_GWS_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][172]GDN_GWS_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][173]GDN_GWS_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][174]GDN_GWS_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][175]GDN_GWS_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][176]GDN_GWS_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][418]PMAX_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][419]PMAX_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][420]PMAX_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][421]PMAX_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][422]PMAX_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][423]PMAX_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][424]PMAX_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][425]PMAX_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][426]PMAX_GEMINI_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][428]PMAX_GWS_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][429]PMAX_GWS_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][430]PMAX_GWS_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][431]PMAX_GWS_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][432]PMAX_GWS_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][433]PMAX_GWS_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][434]PMAX_GWS_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][435]PMAX_GWS_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][436]PMAX_GWS_G1_SL_GEOVN
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][482]SEM_GEMINI_G1_SL_GEOAR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][483]SEM_GEMINI_G1_SL_GEOCO
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][484]SEM_GEMINI_G1_SL_GEOID
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][485]SEM_GEMINI_G1_SL_GEOMY
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][486]SEM_GEMINI_G1_SL_GEOPH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][487]SEM_GEMINI_G1_SL_GEOSG
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][488]SEM_GEMINI_G1_SL_GEOTH
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][489]SEM_GEMINI_G1_SL_GEOTR
root['schemas']['GoogleInternalSubscriptionsFirstpartyV1CallToActionInAppPurchase']['properties']['onramp']['enum'][490]SEM_GEMINI_G1_SL_GEOVN
sandbox/staging-artifactregistry-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-artifactregistry-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-artifactregistry-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-artifactregistry-v1beta2
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-auditrecording-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-auditrecording-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-automotivemaps-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-automotivemaps-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-binaryauthorization-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-binaryauthorization-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-binaryauthorization-v1alpha2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-binaryauthorization-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-clientauthconfig-
iterable_item_added
root['schemas']['Client']['properties']['accountRestrictionService']['enum'][1587]GDM_FRONTIERS
root['schemas']['Client']['properties']['accountRestrictionService']['enumDescriptions'][1587]Google DeepMind Frontiers Web App (deepmind.google.com/frontiers) DeepMind's frontiers demos will be hosted on deepmind.google.com/frontiers/* Contact: gdm-frontiers@google.com
sandbox/staging-clientauthconfig-v1
iterable_item_added
root['schemas']['Client']['properties']['accountRestrictionService']['enum'][1587]GDM_FRONTIERS
root['schemas']['Client']['properties']['accountRestrictionService']['enumDescriptions'][1587]Google DeepMind Frontiers Web App (deepmind.google.com/frontiers) DeepMind's frontiers demos will be hosted on deepmind.google.com/frontiers/* Contact: gdm-frontiers@google.com
sandbox/staging-cloudaicompanion-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudaicompanion-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudaicompanion-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudaicompanion-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudaicompanionadmin-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudaicompanionadmin-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudaicompanionadmin-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudaicompanionadmin-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudasset-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudasset-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudasset-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudasset-v1p1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudasset-v1p2alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudasset-v1p2beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudasset-v1p5alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudasset-v1p5beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudasset-v1p7beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudbi-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudbi-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudbilling-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudbilling-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudbilling-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudbilling-v2beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudchannel-
dictionary_item_added
  • root['resources']['opportunities']['methods']['get']['parameters']['partner']
  • root['resources']['opportunities']['methods']['patch']['parameters']['partner']
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleCloudChannelV1alpha1QualificationInfo']['properties']['publicSector']['description']
new_valueOptional. Whether or not the customer is a public sector organization that requires competing offers from multiple vendors. Can't be edited after the Opportunity is Accepted. Default: false.
old_valueOptional. Whether or not the customer is a public sector organization that requires competing offers from multiple vendors. Can be edited after the Opportunity is Accepted. Default: false.
sandbox/staging-cloudchannel-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudchannel-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudchannel-pa-v2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudchannel-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudchannel-v1alpha1
dictionary_item_added
  • root['resources']['opportunities']['methods']['get']['parameters']['partner']
  • root['resources']['opportunities']['methods']['patch']['parameters']['partner']
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleCloudChannelV1alpha1QualificationInfo']['properties']['publicSector']['description']
new_valueOptional. Whether or not the customer is a public sector organization that requires competing offers from multiple vendors. Can't be edited after the Opportunity is Accepted. Default: false.
old_valueOptional. Whether or not the customer is a public sector organization that requires competing offers from multiple vendors. Can be edited after the Opportunity is Accepted. Default: false.
sandbox/staging-cloudcommerceconsumerprocurement-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudcommerceconsumerprocurement-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudcommerceconsumerprocurement-v1alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudcommerceinventory-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudcommerceinventory-pa-v0
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudcommerceinventoryconsumer-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudcommerceinventoryconsumer-pa-v0
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudcommerceprocurement-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudcommerceprocurement-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudcommerceprocurement-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudcommerceprocurement-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudcrmipfrontend-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-cloudcrmipfrontend-pa-v1
dictionary_item_removed
  • root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integrationRegion']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integration']['description']
new_valueRequired. Resource Name of the integration where template needs to be imported/inserted.
old_valueRequired. Name of the integration where template needs to be imported.
sandbox/staging-cloudcrmipfrontend-pa-v1alpha
dictionary_item_removed
  • root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integrationRegion']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integration']['description']
new_valueRequired. Resource Name of the integration where template needs to be imported/inserted.
old_valueRequired. Name of the integration where template needs to be imported.
sandbox/staging-cloudcrmipfrontend-pa-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-cloudkms-
values_changed
root['revision']
new_value20250219
old_value20250217
sandbox/staging-cloudkms-v1
values_changed
root['revision']
new_value20250219
old_value20250217
sandbox/staging-cloudprivatecatalog-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudprivatecatalog-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudprivatecatalog-v1alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudprivatecatalog-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudprivatecatalogproducer-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudprivatecatalogproducer-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudprivatecatalogproducer-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudrecommendations-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudrecommendations-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudresourcemanager-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudresourcemanager-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudresourcemanager-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudresourcemanager-v2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudresourcemanager-v2alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudresourcemanager-v2beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudresourcemanager-v3
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudsearch-
values_changed
root['revision']
new_value20250219
old_value20250212
sandbox/staging-cloudsearch-v1
values_changed
root['revision']
new_value20250219
old_value20250212
sandbox/staging-cloudsupport-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-cloudsupport-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-cloudsupport-v2
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-cloudsupport-v2beta
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-cloudtrace-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-cloudtrace-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-cloudtrace-v2
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-cloudtrace-v2beta1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-cloudusersettings-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-cloudusersettings-pa-v1alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-containeranalysis-
values_changed
root['revision']
new_value20250219
old_value20250218
iterable_item_added
root['endpoints'][5]
descriptionLocational Endpoint
endpointUrlhttps://staging-containeranalysis.eu.rep.sandbox.googleapis.com/
locationeu
sandbox/staging-containeranalysis-v1
values_changed
root['revision']
new_value20250219
old_value20250218
iterable_item_added
root['endpoints'][5]
descriptionLocational Endpoint
endpointUrlhttps://staging-containeranalysis.eu.rep.sandbox.googleapis.com/
locationeu
sandbox/staging-containeranalysis-v1alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
iterable_item_added
root['endpoints'][5]
descriptionLocational Endpoint
endpointUrlhttps://staging-containeranalysis.eu.rep.sandbox.googleapis.com/
locationeu
sandbox/staging-containeranalysis-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
iterable_item_added
root['endpoints'][5]
descriptionLocational Endpoint
endpointUrlhttps://staging-containeranalysis.eu.rep.sandbox.googleapis.com/
locationeu
sandbox/staging-corplearning-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-corplearning-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-dataflowbackend-pa-
values_changed
root['revision']
new_value20250219
old_value20250215
sandbox/staging-dataflowbackend-pa-v1b3
values_changed
root['revision']
new_value20250219
old_value20250215
sandbox/staging-datamanager-
dictionary_item_added
  • root['resources']['audiencemembers']['methods']['remove']
  • root['schemas']['RemoveAudienceMembersRequest']
  • root['schemas']['RemoveAudienceMembersResponse']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-datamanager-v1
dictionary_item_added
  • root['resources']['audiencemembers']['methods']['remove']
  • root['schemas']['RemoveAudienceMembersRequest']
  • root['schemas']['RemoveAudienceMembersResponse']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-developerscontentsearch-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-developerscontentsearch-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-dialogflow-
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleCloudDialogflowCxV3beta1SearchConfig']['properties']['boostSpecs']['description']
new_valueOptional. Boosting configuration for the datastores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined.
old_valueOptional. Boosting configuration for the datastores.
root['schemas']['GoogleCloudDialogflowCxV3beta1SearchConfig']['properties']['filterSpecs']['description']
new_valueOptional. Filter configuration for the datastores. Maps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined.
old_valueOptional. Filter configuration for the datastores.
sandbox/staging-dialogflow-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-dialogflow-v2
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig']['properties']['boostSpecs']['description']
new_valueOptional. Boost specifications for data stores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined.
old_valueOptional. Boost specifications for data stores.
root['schemas']['GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig']['properties']['filterSpecs']['description']
new_valueOptional. Filter specification for data store queries. TMaps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined.
old_valueOptional. Filter specification for data store queries.
sandbox/staging-dialogflow-v2beta1
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfig']['properties']['filterSpecs']['description']
new_valueOptional. Filter specification for data store queries. Maps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined.
old_valueOptional. Filter specification for data store queries.
root['schemas']['GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecs']['description']
new_valueBoost specifications for data stores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined.
old_valueBoost specifications for data stores.
sandbox/staging-dialogflow-v3
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleCloudDialogflowCxV3SearchConfig']['properties']['boostSpecs']['description']
new_valueOptional. Boosting configuration for the datastores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined.
old_valueOptional. Boosting configuration for the datastores.
root['schemas']['GoogleCloudDialogflowCxV3SearchConfig']['properties']['filterSpecs']['description']
new_valueOptional. Filter configuration for the datastores. Maps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined.
old_valueOptional. Filter configuration for the datastores.
sandbox/staging-dialogflow-v3alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-dialogflow-v3beta1
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleCloudDialogflowCxV3beta1SearchConfig']['properties']['boostSpecs']['description']
new_valueOptional. Boosting configuration for the datastores. Maps from datastore name to their boost configuration. Do not specify more than one BoostSpecs for each datastore name. If multiple BoostSpecs are provided for the same datastore name, the behavior is undefined.
old_valueOptional. Boosting configuration for the datastores.
root['schemas']['GoogleCloudDialogflowCxV3beta1SearchConfig']['properties']['filterSpecs']['description']
new_valueOptional. Filter configuration for the datastores. Maps from datastore name to the filter expression for that datastore. Do not specify more than one FilterSpecs for each datastore name. If multiple FilterSpecs are provided for the same datastore name, the behavior is undefined.
old_valueOptional. Filter configuration for the datastores.
sandbox/staging-essentialcontacts-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-essentialcontacts-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-essentialcontacts-v1alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-essentialcontacts-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-familymanagement-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-familymanagement-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-fcm-
dictionary_item_added
  • root['schemas']['AndroidConfig']['properties']['bandwidthConstrainedOk']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-fcm-v1
dictionary_item_added
  • root['schemas']['AndroidConfig']['properties']['bandwidthConstrainedOk']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-fiamserver-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-fiamserver-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firealerts-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firealerts-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebase-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebase-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebase-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebase-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseabt-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseabt-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseabt-pa-v2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseappdistribution-
dictionary_item_added
  • root['resources']['projects']['methods']
  • root['schemas']['GoogleFirebaseAppdistroV1alphaTestQuota']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-firebaseappdistribution-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-firebaseappdistribution-v1alpha
dictionary_item_added
  • root['resources']['projects']['methods']
  • root['schemas']['GoogleFirebaseAppdistroV1alphaTestQuota']
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-firebaseextensions-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseextensions-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseextensionspublisher-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseextensionspublisher-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebasehosting-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebasehosting-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebasehosting-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebasemessagingcampaigns-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebasemessagingcampaigns-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseml-
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['description']
new_valueRetrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder
old_valueRetrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder
root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['properties']['datastore']['description']
new_valueOptional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
old_valueRequired. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
sandbox/staging-firebaseml-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseml-v1beta2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseml-v2beta
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['description']
new_valueRetrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder
old_valueRetrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder
root['schemas']['GoogleCloudAiplatformV1beta1VertexAISearch']['properties']['datastore']['description']
new_valueOptional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
old_valueRequired. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
sandbox/staging-firebaseremoteconfig-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseremoteconfig-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseremoteconfig-pa-v2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebaseremoteconfigrealtime-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-firebaseremoteconfigrealtime-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-firebasesagepredictions-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebasesagepredictions-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebasesegmentation-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-firebasesegmentation-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-firebasestorage-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebasestorage-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebasestorage-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-firebasetargeting-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-firebasetargeting-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-fireconsole-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-fireconsole-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-gcmcontextualcampaign-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-gcmcontextualcampaign-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-gcmcontextualcampaign-pa-v2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-generativelanguage-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-generativelanguage-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-generativelanguage-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-generativelanguage-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-generativelanguage-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-generativelanguage-v1beta2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-generativelanguage-v1beta3
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-geofeedtaskrouting-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-geofeedtaskrouting-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-growth-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-growth-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-guidedhelp-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-guidedhelp-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-iam-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-iam-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-iam-v1beta
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-iam-v2
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-iam-v2alpha
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-iam-v2beta
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-iam-v3
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-iam-v3alpha
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-iam-v3beta
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-iap-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-iap-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-iap-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-identitytoolkit-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-identitytoolkit-v2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-identitytoolkit-v2alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-identitytoolkit-v2beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-instantmessaging-pa-
dictionary_item_added
  • root['resources']['messages']['methods']['createMlsConversation']['deprecated']
  • root['schemas']['InstantmessagingStagingPaSandboxGoogleInternalCommunicationsInstantmessagingV1PrewarmReceiverRequest']['properties']['groupId']
  • root['schemas']['InstantmessagingStagingPaSandboxGoogleInternalCommunicationsInstantmessagingV1PrewarmReceiverRequest']['properties']['contactIds']['description']
values_changed
root['resources']['messages']['methods']['createMlsConversation']['description']
new_valueDEPRECATED. Used MlsService.CreateMlsConversation instead. Create MLS Conversation creates an MLS conversation. This is expected to be used for both 1:1 and group conversations. In the first iteration (go/mls-client-server-tg-protocol-mvp), this involves sending a commit message back to the client creating the group, and fanning out a welcome message to all the other participants. Eventually, this will be extended to also begin to persist new MLS specific state on behalf of the conversation, and to perform additional validation of the MLS protocol messages.
old_valueCreate MLS Conversation creates an MLS conversation. This is expected to be used for both 1:1 and group conversations. In the first iteration (go/mls-client-server-tg-protocol-mvp), this involves sending a commit message back to the client creating the group, and fanning out a welcome message to all the other participants. Eventually, this will be extended to also begin to persist new MLS specific state on behalf of the conversation, and to perform additional validation of the MLS protocol messages.
root['revision']
new_value20250220
old_value20250218
sandbox/staging-instantmessaging-pa-v1
dictionary_item_added
  • root['resources']['messages']['methods']['createMlsConversation']['deprecated']
  • root['schemas']['InstantmessagingStagingPaSandboxGoogleInternalCommunicationsInstantmessagingV1PrewarmReceiverRequest']['properties']['groupId']
  • root['schemas']['InstantmessagingStagingPaSandboxGoogleInternalCommunicationsInstantmessagingV1PrewarmReceiverRequest']['properties']['contactIds']['description']
values_changed
root['resources']['messages']['methods']['createMlsConversation']['description']
new_valueDEPRECATED. Used MlsService.CreateMlsConversation instead. Create MLS Conversation creates an MLS conversation. This is expected to be used for both 1:1 and group conversations. In the first iteration (go/mls-client-server-tg-protocol-mvp), this involves sending a commit message back to the client creating the group, and fanning out a welcome message to all the other participants. Eventually, this will be extended to also begin to persist new MLS specific state on behalf of the conversation, and to perform additional validation of the MLS protocol messages.
old_valueCreate MLS Conversation creates an MLS conversation. This is expected to be used for both 1:1 and group conversations. In the first iteration (go/mls-client-server-tg-protocol-mvp), this involves sending a commit message back to the client creating the group, and fanning out a welcome message to all the other participants. Eventually, this will be extended to also begin to persist new MLS specific state on behalf of the conversation, and to perform additional validation of the MLS protocol messages.
root['revision']
new_value20250220
old_value20250218
sandbox/staging-integrations-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-integrations-v1
dictionary_item_removed
  • root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integrationRegion']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integration']['description']
new_valueRequired. Resource Name of the integration where template needs to be imported/inserted.
old_valueRequired. Name of the integration where template needs to be imported.
sandbox/staging-integrations-v1alpha
dictionary_item_removed
  • root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integrationRegion']
values_changed
root['revision']
new_value20250220
old_value20250219
root['schemas']['GoogleCloudIntegrationsV1alphaImportTemplateRequest']['properties']['integration']['description']
new_valueRequired. Resource Name of the integration where template needs to be imported/inserted.
old_valueRequired. Name of the integration where template needs to be imported.
sandbox/staging-integrations-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-kidsmanagement-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-kidsmanagement-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-kidsnotification-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-kidsnotification-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-listallowedkids-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-listallowedkids-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-logging-
values_changed
root['revision']
new_value20250217
old_value20250214
sandbox/staging-logging-v1
values_changed
root['revision']
new_value20250217
old_value20250214
sandbox/staging-logging-v1beta3
values_changed
root['revision']
new_value20250217
old_value20250214
sandbox/staging-logging-v2
values_changed
root['revision']
new_value20250217
old_value20250214
sandbox/staging-logging-v2beta1
values_changed
root['revision']
new_value20250217
old_value20250214
sandbox/staging-mapsplatformdatasets-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-mapsplatformdatasets-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-mapsplatformdatasets-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-mlengine-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-mlengine-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-mlkit-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-mlkit-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-mobileperformancereporting-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-mobileperformancereporting-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-monitoring-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-monitoring-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-monitoring-v3
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-monospace-pa-
dictionary_item_added
  • root['schemas']['Workspace']['properties']['firebaseProjectId']
values_changed
root['resources']['workspaces']['methods']['patch']['parameters']['updateMask']['description']
new_valueSpecifies which fields in the workspace to update. As for now, only supports to update workspace name, image url, and firebase project id.
old_valueSpecifies which fields in the workspace to update. As for now, only supports to update workspace name and image url.
root['revision']
new_value20250219
old_value20250218
sandbox/staging-monospace-pa-v1
dictionary_item_added
  • root['schemas']['Workspace']['properties']['firebaseProjectId']
values_changed
root['resources']['workspaces']['methods']['patch']['parameters']['updateMask']['description']
new_valueSpecifies which fields in the workspace to update. As for now, only supports to update workspace name, image url, and firebase project id.
old_valueSpecifies which fields in the workspace to update. As for now, only supports to update workspace name and image url.
root['revision']
new_value20250219
old_value20250218
sandbox/staging-myphonenumbers-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-myphonenumbers-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-notifications-pa-
dictionary_item_added
  • root['schemas']['GoogleLogsTapandpayAndroid__PassesGeofencingEvent']
  • root['schemas']['WalletGooglepayCommon__IdCardCtaTarget']
  • root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['properties']['valuablesGeofencingEvent']
  • root['schemas']['WalletGooglepayCommon__MdocUnderReviewTarget']['properties']['screenType']
  • root['schemas']['WalletGooglepayCommon__NavigationTarget']['properties']['idCardCta']
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['description']
new_valueTop-level extension to be reported Next id: 209
old_valueTop-level extension to be reported Next id: 208
root['schemas']['WalletGooglepayCommon__MdocUnderReviewTarget']['description']
new_valueA target to intent to the mdoc under review screen. Next id: 4
old_valueA target to intent to the mdoc under review screen. Next id: 3
root['schemas']['WalletGooglepayCommon__NavigationTarget']['description']
new_valueThe target to navigate to. A target should be a pure navigation target. I.e. the target should not represent an action to be taken (besides navigation). Next id: 73
old_valueThe target to navigate to. A target should be a pure navigation target. I.e. the target should not represent an action to be taken (besides navigation). Next id: 72
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__BackupRestoreEvent']['properties']['errorType']['enum'][9]NO_DATA_TO_RESTORE
sandbox/staging-notifications-pa-v1
dictionary_item_added
  • root['schemas']['GoogleLogsTapandpayAndroid__PassesGeofencingEvent']
  • root['schemas']['WalletGooglepayCommon__IdCardCtaTarget']
  • root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['properties']['valuablesGeofencingEvent']
  • root['schemas']['WalletGooglepayCommon__MdocUnderReviewTarget']['properties']['screenType']
  • root['schemas']['WalletGooglepayCommon__NavigationTarget']['properties']['idCardCta']
values_changed
root['revision']
new_value20250219
old_value20250218
root['schemas']['GoogleLogsTapandpayAndroid__Tp2AppLogEvent']['description']
new_valueTop-level extension to be reported Next id: 209
old_valueTop-level extension to be reported Next id: 208
root['schemas']['WalletGooglepayCommon__MdocUnderReviewTarget']['description']
new_valueA target to intent to the mdoc under review screen. Next id: 4
old_valueA target to intent to the mdoc under review screen. Next id: 3
root['schemas']['WalletGooglepayCommon__NavigationTarget']['description']
new_valueThe target to navigate to. A target should be a pure navigation target. I.e. the target should not represent an action to be taken (besides navigation). Next id: 73
old_valueThe target to navigate to. A target should be a pure navigation target. I.e. the target should not represent an action to be taken (besides navigation). Next id: 72
iterable_item_added
root['schemas']['GoogleLogsTapandpayAndroid__BackupRestoreEvent']['properties']['errorType']['enum'][9]NO_DATA_TO_RESTORE
sandbox/staging-ogads-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
iterable_item_added
root['resources']['v1']['methods']['getdata']['parameters']['hostProduct']['enum'][718]CODE_ASSIST
root['resources']['v1']['methods']['getdata']['parameters']['hostProduct']['enumDescriptions'][718]go/crescendo-ux
root['resources']['v1']['methods']['getdata']['parameters']['subproduct']['enum'][718]CODE_ASSIST
root['resources']['v1']['methods']['getdata']['parameters']['subproduct']['enumDescriptions'][718]go/crescendo-ux
sandbox/staging-ogads-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
iterable_item_added
root['resources']['v1']['methods']['getdata']['parameters']['hostProduct']['enum'][718]CODE_ASSIST
root['resources']['v1']['methods']['getdata']['parameters']['hostProduct']['enumDescriptions'][718]go/crescendo-ux
root['resources']['v1']['methods']['getdata']['parameters']['subproduct']['enum'][718]CODE_ASSIST
root['resources']['v1']['methods']['getdata']['parameters']['subproduct']['enumDescriptions'][718]go/crescendo-ux
sandbox/staging-orgpolicy-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-orgpolicy-v2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-orgpolicy-v2alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-oslogin-
dictionary_item_removed
  • root['resources']['projects']
  • root['schemas']['GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest']
  • root['schemas']['GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse']
values_changed
root['revision']
new_value20250209
old_value20250216
sandbox/staging-oslogin-v1
values_changed
root['revision']
new_value20250209
old_value20250216
sandbox/staging-oslogin-v1alpha
dictionary_item_removed
  • root['resources']['projects']
  • root['schemas']['GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest']
  • root['schemas']['GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse']
values_changed
root['revision']
new_value20250209
old_value20250216
sandbox/staging-oslogin-v1beta
dictionary_item_removed
  • root['resources']['projects']
  • root['schemas']['GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest']
  • root['schemas']['GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse']
values_changed
root['revision']
new_value20250209
old_value20250216
sandbox/staging-peoplestack-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-peoplestack-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policyremediator-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policyremediator-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policysimulator-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policysimulator-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policysimulator-v1alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policysimulator-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policytroubleshooter-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policytroubleshooter-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policytroubleshooter-v1beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policytroubleshooter-v2alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policytroubleshooter-v3
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policytroubleshooter-v3alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-policytroubleshooter-v3beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-privacysandboxmaven-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-privacysandboxmaven-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-quantum-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-quantum-v1alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-reach-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-reach-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/staging-recommender-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-recommender-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-recommender-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-retail-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-retail-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-retail-v2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-retail-v2alpha
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-retail-v2beta
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-salesforceshopping-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-salesforceshopping-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-sasportal-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-sasportal-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-sasportal-v1alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-scone-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-scone-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-searchresearcherresults-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-searchresearcherresults-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-secretmanager-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-secretmanager-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-secretmanager-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-secretmanager-v1beta2
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-securitycenter-
values_changed
root['revision']
new_value20250219
old_value20250218
iterable_item_added
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
sandbox/staging-securitycenter-v1
values_changed
root['revision']
new_value20250219
old_value20250218
iterable_item_added
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
sandbox/staging-securitycenter-v1alpha2
values_changed
root['revision']
new_value20250219
old_value20250218
iterable_item_added
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
sandbox/staging-securitycenter-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
iterable_item_added
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
sandbox/staging-securitycenter-v1beta2
values_changed
root['revision']
new_value20250219
old_value20250218
iterable_item_added
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
sandbox/staging-securitycenter-v1p1alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
iterable_item_added
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
sandbox/staging-securitycenter-v1p1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
iterable_item_added
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
sandbox/staging-securitycenter-v2
values_changed
root['revision']
new_value20250219
old_value20250218
iterable_item_added
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['GoogleCloudSecuritycenterV2MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['additionalTechniques']['items']['enumDescriptions'][26]T1098.003
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enum'][26]ADDITIONAL_CLOUD_ROLES
root['schemas']['MitreAttack']['properties']['primaryTechniques']['items']['enumDescriptions'][26]T1098.003
sandbox/staging-servicemanagement-
values_changed
root['revision']
new_value20250220
old_value20250218
root['schemas']['Documentation']['properties']['sectionOverrides']['description']
new_valueSpecifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries
old_valueSpecifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
root['schemas']['DocumentationRule']['properties']['disableReplacementWords']['description']
new_valueString of comma or space separated case-sensitive words for which method/field name replacement will be disabled.
old_valueString of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
sandbox/staging-servicemanagement-v1
values_changed
root['revision']
new_value20250220
old_value20250218
root['schemas']['Documentation']['properties']['sectionOverrides']['description']
new_valueSpecifies section and content to override the boilerplate content. Currently overrides following sections: 1. rest.service.client_libraries
old_valueSpecifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
root['schemas']['DocumentationRule']['properties']['disableReplacementWords']['description']
new_valueString of comma or space separated case-sensitive words for which method/field name replacement will be disabled.
old_valueString of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
sandbox/staging-shoppingdataintegration-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-shoppingdataintegration-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-spectrumsas-pa-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-spectrumsas-pa-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-spectrumsas-pa-v1alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-taskassist-pa-
values_changed
root['revision']
new_value20250218
old_value20250217
sandbox/staging-taskassist-pa-v1
values_changed
root['revision']
new_value20250218
old_value20250217
sandbox/staging-taskassist-pa-v2
values_changed
root['revision']
new_value20250218
old_value20250217
sandbox/staging-toolresults-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-toolresults-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-toolresults-v1beta3
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/staging-translate-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-translate-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-translate-v3
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-translate-v3alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-translate-v3beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-translation-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-translation-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-translation-v3
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-translation-v3alpha1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-translation-v3beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-travelpartnerprices-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-travelpartnerprices-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-userpaneltv-pa-
dictionary_item_added
  • root['schemas']['AutoRestartConfig']
  • root['schemas']['GetMeterConfigResponse']['properties']['autoRestartConfig']
values_changed
root['revision']
new_value20250219
old_value20250217
root['schemas']['GetMeterConfigResponse']['description']
new_valueNext ID: 35
old_valueNext ID: 34
sandbox/staging-userpaneltv-pa-v1
dictionary_item_added
  • root['schemas']['AutoRestartConfig']
  • root['schemas']['GetMeterConfigResponse']['properties']['autoRestartConfig']
values_changed
root['revision']
new_value20250219
old_value20250217
root['schemas']['GetMeterConfigResponse']['description']
new_valueNext ID: 35
old_valueNext ID: 34
sandbox/staging-vision-
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-vision-v1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-vision-v1p1beta1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-vision-v1p2beta1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-vision-v1p3beta1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-vision-v1p4beta1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/staging-workstations-v1
values_changed
root
new_value
auth
oauth2
scopes
https://www.googleapis.com/auth/cloud-platform
descriptionSee, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
basePath
baseUrlhttps://staging-workstations.sandbox.googleapis.com/
batchPathbatch
canonicalNameCloud Workstations
descriptionAllows administrators to create managed developer environments in the cloud.
discoveryVersionv1
documentationLinkhttps://cloud.google.com/workstations
fullyEncodeReservedExpansionTrue
icons
x16http://www.google.com/images/icons/product/search-16.gif
x32http://www.google.com/images/icons/product/search-32.gif
idworkstations:v1
kinddiscovery#restDescription
mtlsRootUrlhttps://staging-workstations.mtls.sandbox.googleapis.com/
nameworkstations
ownerDomaingoogle.com
ownerNameGoogle
parameters
$.xgafv
descriptionV1 error format.
enum
  • 1
  • 2
enumDescriptions
  • v1 error format
  • v2 error format
locationquery
typestring
access_token
descriptionOAuth access token.
locationquery
typestring
alt
defaultjson
descriptionData format for response.
enum
  • json
  • media
  • proto
enumDescriptions
  • Responses with Content-Type of application/json
  • Media download with context-dependent Content-Type
  • Responses with Content-Type of application/x-protobuf
locationquery
typestring
callback
descriptionJSONP
locationquery
typestring
fields
descriptionSelector specifying which fields to include in a partial response.
locationquery
typestring
key
descriptionAPI key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
locationquery
typestring
oauth_token
descriptionOAuth 2.0 token for the current user.
locationquery
typestring
prettyPrint
defaulttrue
descriptionReturns response with indentations and line breaks.
locationquery
typeboolean
quotaUser
descriptionAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
locationquery
typestring
uploadType
descriptionLegacy upload protocol for media (e.g. "media", "multipart").
locationquery
typestring
upload_protocol
descriptionUpload protocol for media (e.g. "raw", "multipart").
locationquery
typestring
protocolrest
resources
projects
resources
locations
methods
get
descriptionGets information about a location.
flatPathv1/projects/{projectsId}/locations/{locationsId}
httpMethodGET
idworkstations.projects.locations.get
parameterOrder
  • name
parameters
name
descriptionResource name for the location.
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refLocation
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists information about the supported locations for this service.
flatPathv1/projects/{projectsId}/locations
httpMethodGET
idworkstations.projects.locations.list
parameterOrder
  • name
parameters
filter
descriptionA filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
locationquery
typestring
name
descriptionThe resource that owns the locations collection, if applicable.
locationpath
pattern^projects/[^/]+$
requiredTrue
typestring
pageSize
descriptionThe maximum number of results to return. If not set, the service selects a default.
formatint32
locationquery
typeinteger
pageToken
descriptionA page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
locationquery
typestring
pathv1/{+name}/locations
response
$refListLocationsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
resources
operations
methods
cancel
descriptionStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
flatPathv1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
httpMethodPOST
idworkstations.projects.locations.operations.cancel
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource to be cancelled.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1/{+name}:cancel
request
$refCancelOperationRequest
response
$refGoogleProtobufEmpty
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
flatPathv1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
httpMethodDELETE
idworkstations.projects.locations.operations.delete
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource to be deleted.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refGoogleProtobufEmpty
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
flatPathv1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
httpMethodGET
idworkstations.projects.locations.operations.get
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
flatPathv1/projects/{projectsId}/locations/{locationsId}/operations
httpMethodGET
idworkstations.projects.locations.operations.list
parameterOrder
  • name
parameters
filter
descriptionThe standard list filter.
locationquery
typestring
name
descriptionThe name of the operation's parent resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
pageSize
descriptionThe standard list page size.
formatint32
locationquery
typeinteger
pageToken
descriptionThe standard list page token.
locationquery
typestring
pathv1/{+name}/operations
response
$refListOperationsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
workstationClusters
methods
create
descriptionCreates a new workstation cluster.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters
httpMethodPOST
idworkstations.projects.locations.workstationClusters.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
workstationClusterId
descriptionRequired. ID to use for the workstation cluster.
locationquery
typestring
pathv1/{+parent}/workstationClusters
request
$refWorkstationCluster
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes the specified workstation cluster.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
httpMethodDELETE
idworkstations.projects.locations.workstationClusters.delete
parameterOrder
  • name
parameters
etag
descriptionOptional. If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag.
locationquery
typestring
force
descriptionOptional. If set, any workstation configurations and workstations in the workstation cluster are also deleted. Otherwise, the request only works if the workstation cluster has no configurations or workstations.
locationquery
typeboolean
name
descriptionRequired. Name of the workstation cluster to delete.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
requiredTrue
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not apply it.
locationquery
typeboolean
pathv1/{+name}
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionReturns the requested workstation cluster.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
httpMethodGET
idworkstations.projects.locations.workstationClusters.get
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the requested resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refWorkstationCluster
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionReturns all workstation clusters in the specified location.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters
httpMethodGET
idworkstations.projects.locations.workstationClusters.list
parameterOrder
  • parent
parameters
pageSize
descriptionOptional. Maximum number of items to return.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. next_page_token value returned from a previous List request, if any.
locationquery
typestring
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/workstationClusters
response
$refListWorkstationClustersResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
patch
descriptionUpdates an existing workstation cluster.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
httpMethodPATCH
idworkstations.projects.locations.workstationClusters.patch
parameterOrder
  • name
parameters
allowMissing
descriptionOptional. If set, and the workstation cluster is not found, a new workstation cluster will be created. In this situation, update_mask is ignored.
locationquery
typeboolean
name
descriptionIdentifier. Full name of this workstation cluster.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired. Mask that specifies which fields in the workstation cluster should be updated.
formatgoogle-fieldmask
locationquery
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
pathv1/{+name}
request
$refWorkstationCluster
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
resources
workstationConfigs
methods
create
descriptionCreates a new workstation configuration.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
requiredTrue
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
workstationConfigId
descriptionRequired. ID to use for the workstation configuration.
locationquery
typestring
pathv1/{+parent}/workstationConfigs
request
$refWorkstationConfig
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes the specified workstation configuration.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
httpMethodDELETE
idworkstations.projects.locations.workstationClusters.workstationConfigs.delete
parameterOrder
  • name
parameters
etag
descriptionOptional. If set, the request is rejected if the latest version of the workstation configuration on the server does not have this ETag.
locationquery
typestring
force
descriptionOptional. If set, any workstations in the workstation configuration are also deleted. Otherwise, the request works only if the workstation configuration has no workstations.
locationquery
typeboolean
name
descriptionRequired. Name of the workstation configuration to delete.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
pathv1/{+name}
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionReturns the requested workstation configuration.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.get
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the requested resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refWorkstationConfig
scopes
  • https://www.googleapis.com/auth/cloud-platform
getIamPolicy
descriptionGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:getIamPolicy
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.getIamPolicy
parameterOrder
  • resource
parameters
options.requestedPolicyVersion
descriptionOptional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
formatint32
locationquery
typeinteger
resource
descriptionREQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:getIamPolicy
response
$refPolicy
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionReturns all workstation configurations in the specified cluster.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.list
parameterOrder
  • parent
parameters
pageSize
descriptionOptional. Maximum number of items to return.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. next_page_token value returned from a previous List request, if any.
locationquery
typestring
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/workstationConfigs
response
$refListWorkstationConfigsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
listUsable
descriptionReturns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs:listUsable
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.listUsable
parameterOrder
  • parent
parameters
pageSize
descriptionOptional. Maximum number of items to return.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. next_page_token value returned from a previous List request, if any.
locationquery
typestring
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/workstationConfigs:listUsable
response
$refListUsableWorkstationConfigsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
patch
descriptionUpdates an existing workstation configuration.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
httpMethodPATCH
idworkstations.projects.locations.workstationClusters.workstationConfigs.patch
parameterOrder
  • name
parameters
allowMissing
descriptionOptional. If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored.
locationquery
typeboolean
name
descriptionIdentifier. Full name of this workstation configuration.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired. Mask specifying which fields in the workstation configuration should be updated.
formatgoogle-fieldmask
locationquery
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
pathv1/{+name}
request
$refWorkstationConfig
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
setIamPolicy
descriptionSets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:setIamPolicy
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.setIamPolicy
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:setIamPolicy
request
$refSetIamPolicyRequest
response
$refPolicy
scopes
  • https://www.googleapis.com/auth/cloud-platform
testIamPermissions
descriptionReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:testIamPermissions
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.testIamPermissions
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:testIamPermissions
request
$refTestIamPermissionsRequest
response
$refTestIamPermissionsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
resources
workstations
methods
create
descriptionCreates a new workstation.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
workstationId
descriptionRequired. ID to use for the workstation.
locationquery
typestring
pathv1/{+parent}/workstations
request
$refWorkstation
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes the specified workstation.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
httpMethodDELETE
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.delete
parameterOrder
  • name
parameters
etag
descriptionOptional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
locationquery
typestring
name
descriptionRequired. Name of the workstation to delete.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
pathv1/{+name}
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
generateAccessToken
descriptionReturns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation. Once generated this token cannot be revoked and is good for the lifetime of the token.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:generateAccessToken
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.generateAccessToken
parameterOrder
  • workstation
parameters
workstation
descriptionRequired. Name of the workstation for which the access token should be generated.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1/{+workstation}:generateAccessToken
request
$refGenerateAccessTokenRequest
response
$refGenerateAccessTokenResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionReturns the requested workstation.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.get
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the requested resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refWorkstation
scopes
  • https://www.googleapis.com/auth/cloud-platform
getIamPolicy
descriptionGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:getIamPolicy
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.getIamPolicy
parameterOrder
  • resource
parameters
options.requestedPolicyVersion
descriptionOptional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
formatint32
locationquery
typeinteger
resource
descriptionREQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:getIamPolicy
response
$refPolicy
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionReturns all Workstations using the specified workstation configuration.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.list
parameterOrder
  • parent
parameters
pageSize
descriptionOptional. Maximum number of items to return.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. next_page_token value returned from a previous List request, if any.
locationquery
typestring
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/workstations
response
$refListWorkstationsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
listUsable
descriptionReturns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations:listUsable
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.listUsable
parameterOrder
  • parent
parameters
pageSize
descriptionOptional. Maximum number of items to return.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. next_page_token value returned from a previous List request, if any.
locationquery
typestring
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/workstations:listUsable
response
$refListUsableWorkstationsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
patch
descriptionUpdates an existing workstation.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
httpMethodPATCH
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.patch
parameterOrder
  • name
parameters
allowMissing
descriptionOptional. If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored.
locationquery
typeboolean
name
descriptionIdentifier. Full name of this workstation.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired. Mask specifying which fields in the workstation configuration should be updated.
formatgoogle-fieldmask
locationquery
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
pathv1/{+name}
request
$refWorkstation
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
setIamPolicy
descriptionSets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:setIamPolicy
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.setIamPolicy
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:setIamPolicy
request
$refSetIamPolicyRequest
response
$refPolicy
scopes
  • https://www.googleapis.com/auth/cloud-platform
start
descriptionStarts running a workstation so that users can connect to it.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:start
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.start
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the workstation to start.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1/{+name}:start
request
$refStartWorkstationRequest
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
stop
descriptionStops running a workstation, reducing costs.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:stop
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.stop
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the workstation to stop.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1/{+name}:stop
request
$refStopWorkstationRequest
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
testIamPermissions
descriptionReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
flatPathv1/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:testIamPermissions
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.testIamPermissions
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1/{+resource}:testIamPermissions
request
$refTestIamPermissionsRequest
response
$refTestIamPermissionsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
revision20250217
rootUrlhttps://staging-workstations.sandbox.googleapis.com/
schemas
Accelerator
descriptionAn accelerator card attached to the instance.
idAccelerator
properties
count
descriptionOptional. Number of accelerator cards exposed to the instance.
formatint32
typeinteger
type
descriptionOptional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`.
typestring
typeobject
AuditConfig
descriptionSpecifies 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.
idAuditConfig
properties
auditLogConfigs
descriptionThe configuration for logging of each type of permission.
items
$refAuditLogConfig
typearray
service
descriptionSpecifies 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.
typestring
typeobject
AuditLogConfig
descriptionProvides 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.
idAuditLogConfig
properties
exemptedMembers
descriptionSpecifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
items
typestring
typearray
logType
descriptionThe log type that this config enables.
enum
  • LOG_TYPE_UNSPECIFIED
  • ADMIN_READ
  • DATA_WRITE
  • DATA_READ
enumDescriptions
  • Default case. Should never be this.
  • Admin reads. Example: CloudIAM getIamPolicy
  • Data writes. Example: CloudSQL Users create
  • Data reads. Example: CloudSQL Users list
typestring
typeobject
Binding
descriptionAssociates `members`, or principals, with a `role`.
idBinding
properties
condition
$refExpr
descriptionThe 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).
members
descriptionSpecifies 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`.
items
typestring
typearray
role
descriptionRole 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).
typestring
typeobject
BoostConfig
descriptionA boost configuration is a set of resources that a workstation can use to increase its performance. If you specify a boost configuration, upon startup, workstation users can choose to use a VM provisioned under the boost config by passing the boost config ID in the start request. If the workstation user does not provide a boost config ID in the start request, the system will choose a VM from the pool provisioned under the default config.
idBoostConfig
properties
accelerators
descriptionOptional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to `none`.
items
$refAccelerator
typearray
bootDiskSizeGb
descriptionOptional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB.
formatint32
typeinteger
enableNestedVirtualization
descriptionOptional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series.
typeboolean
id
descriptionRequired. The ID to be used for the boost configuration.
typestring
machineType
descriptionOptional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`.
typestring
poolSize
descriptionOptional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`.
formatint32
typeinteger
typeobject
CancelOperationRequest
descriptionThe request message for Operations.CancelOperation.
idCancelOperationRequest
properties
typeobject
Container
descriptionA Docker container.
idContainer
properties
args
descriptionOptional. Arguments passed to the entrypoint.
items
typestring
typearray
command
descriptionOptional. If set, overrides the default ENTRYPOINT specified by the image.
items
typestring
typearray
env
additionalProperties
typestring
descriptionOptional. Environment variables passed to the container's entrypoint.
typeobject
image
descriptionOptional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of [preconfigured images](https://cloud.google.com/workstations/docs/preconfigured-base-images), but you can create your own [custom container images](https://cloud.google.com/workstations/docs/custom-container-images). If using a private image, the `host.gceInstance.serviceAccount` field must be specified in the workstation configuration. If using a custom container image, the service account must have [Artifact Registry Reader](https://cloud.google.com/artifact-registry/docs/access-control#roles) permission to pull the specified image. Otherwise, the image must be publicly accessible.
typestring
runAsUser
descriptionOptional. If set, overrides the USER specified in the image with the given uid.
formatint32
typeinteger
workingDir
descriptionOptional. If set, overrides the default DIR specified by the image.
typestring
typeobject
CustomerEncryptionKey
descriptionA customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties).
idCustomerEncryptionKey
properties
kmsKey
descriptionImmutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration.
typestring
kmsKeyServiceAccount
descriptionImmutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member).
typestring
typeobject
DomainConfig
descriptionConfiguration options for a custom domain.
idDomainConfig
properties
domain
descriptionImmutable. Domain used by Workstations for HTTP ingress.
typestring
typeobject
EphemeralDirectory
descriptionAn ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.
idEphemeralDirectory
properties
gcePd
$refGcePersistentDisk
descriptionAn EphemeralDirectory backed by a Compute Engine persistent disk.
mountPath
descriptionRequired. Location of this directory in the running workstation.
typestring
typeobject
Expr
descriptionRepresents 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.
idExpr
properties
description
descriptionOptional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
typestring
expression
descriptionTextual representation of an expression in Common Expression Language syntax.
typestring
location
descriptionOptional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
typestring
title
descriptionOptional. 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.
typestring
typeobject
GceConfidentialInstanceConfig
descriptionA set of Compute Engine Confidential VM instance options.
idGceConfidentialInstanceConfig
properties
enableConfidentialCompute
descriptionOptional. Whether the instance has confidential compute enabled.
typeboolean
typeobject
GceInstance
descriptionA runtime using a Compute Engine instance.
idGceInstance
properties
accelerators
descriptionOptional. A list of the type and count of accelerator cards attached to the instance.
items
$refAccelerator
typearray
boostConfigs
descriptionOptional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
items
$refBoostConfig
typearray
bootDiskSizeGb
descriptionOptional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB.
formatint32
typeinteger
confidentialInstanceConfig
$refGceConfidentialInstanceConfig
descriptionOptional. A set of Compute Engine Confidential VM instance options.
disablePublicIpAddresses
descriptionOptional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses).
typeboolean
disableSsh
descriptionOptional. Whether to disable SSH access to the VM.
typeboolean
enableNestedVirtualization
descriptionOptional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series.
typeboolean
machineType
descriptionOptional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types).
typestring
poolSize
descriptionOptional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API.
formatint32
typeinteger
pooledInstances
descriptionOutput only. Number of instances currently available in the pool for faster workstation startup.
formatint32
readOnlyTrue
typeinteger
serviceAccount
descriptionOptional. The email address of the service account for Cloud Workstations VMs created with this configuration. When specified, be sure that the service account has `logging.logEntries.create` and `monitoring.timeSeries.create` permissions on the project so it can write logs out to Cloud Logging. If using a custom container image, the service account must have [Artifact Registry Reader](https://cloud.google.com/artifact-registry/docs/access-control#roles) permission to pull the specified image. If you as the administrator want to be able to `ssh` into the underlying VM, you need to set this value to a service account for which you have the `iam.serviceAccounts.actAs` permission. Conversely, if you don't want anyone to be able to `ssh` into the underlying VM, use a service account where no one has that permission. If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
typestring
serviceAccountScopes
descriptionOptional. Scopes to grant to the service_account. When specified, users of workstations under this configuration must have `iam.serviceAccounts.actAs` on the service account.
items
typestring
typearray
shieldedInstanceConfig
$refGceShieldedInstanceConfig
descriptionOptional. A set of Compute Engine Shielded instance options.
tags
descriptionOptional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies [network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs created with this configuration. These network tags enable the creation of [firewall rules](https://cloud.google.com/workstations/docs/configure-firewall-rules).
items
typestring
typearray
vmTags
additionalProperties
typestring
descriptionOptional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as [resource manager tags](https://cloud.google.com/resource-manager/docs/tags/tags-overview). Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`.
typeobject
typeobject
GceInstanceHost
descriptionThe Compute Engine instance host.
idGceInstanceHost
properties
id
descriptionOptional. Output only. The ID of the Compute Engine instance.
readOnlyTrue
typestring
name
descriptionOptional. Output only. The name of the Compute Engine instance.
readOnlyTrue
typestring
zone
descriptionOptional. Output only. The zone of the Compute Engine instance.
readOnlyTrue
typestring
typeobject
GcePersistentDisk
descriptionAn EphemeralDirectory is backed by a Compute Engine persistent disk.
idGcePersistentDisk
properties
diskType
descriptionOptional. Type of the disk to use. Defaults to `"pd-standard"`.
typestring
readOnly
descriptionOptional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and source_snapshot must be set.
typeboolean
sourceImage
descriptionOptional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable.
typestring
sourceSnapshot
descriptionOptional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable.
typestring
typeobject
GceRegionalPersistentDisk
descriptionA Persistent Directory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that mounts to the workstation VM at `/home` when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.
idGceRegionalPersistentDisk
properties
diskType
descriptionOptional. The [type of the persistent disk](https://cloud.google.com/compute/docs/disks#disk-types) for the home directory. Defaults to `"pd-standard"`.
typestring
fsType
descriptionOptional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. Defaults to `"ext4"`.
typestring
reclaimPolicy
descriptionOptional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`.
enum
  • RECLAIM_POLICY_UNSPECIFIED
  • DELETE
  • RETAIN
enumDescriptions
  • Do not use.
  • Delete the persistent disk when deleting the workstation.
  • Keep the persistent disk when deleting the workstation. An administrator must manually delete the disk.
typestring
sizeGb
descriptionOptional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. If less than `200` GB, the disk_type must be `"pd-balanced"` or `"pd-ssd"`.
formatint32
typeinteger
sourceSnapshot
descriptionOptional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.
typestring
typeobject
GceShieldedInstanceConfig
descriptionA set of Compute Engine Shielded instance options.
idGceShieldedInstanceConfig
properties
enableIntegrityMonitoring
descriptionOptional. Whether the instance has integrity monitoring enabled.
typeboolean
enableSecureBoot
descriptionOptional. Whether the instance has Secure Boot enabled.
typeboolean
enableVtpm
descriptionOptional. Whether the instance has the vTPM enabled.
typeboolean
typeobject
GenerateAccessTokenRequest
descriptionRequest message for GenerateAccessToken.
idGenerateAccessTokenRequest
properties
expireTime
descriptionDesired expiration time of the access token. This value must be at most 24 hours in the future. If a value is not specified, the token's expiration time will be set to a default value of 1 hour in the future.
formatgoogle-datetime
typestring
port
descriptionOptional. Port for which the access token should be generated. If specified, the generated access token grants access only to the specified port of the workstation. If specified, values must be within the range [1 - 65535]. If not specified, the generated access token grants access to all ports of the workstation.
formatint32
typeinteger
ttl
descriptionDesired lifetime duration of the access token. This value must be at most 24 hours. If a value is not specified, the token's lifetime will be set to a default value of 1 hour.
formatgoogle-duration
typestring
typeobject
GenerateAccessTokenResponse
descriptionResponse message for GenerateAccessToken.
idGenerateAccessTokenResponse
properties
accessToken
descriptionThe generated bearer access token. To use this token, include it in an Authorization header of an HTTP request sent to the associated workstation's hostname—for example, `Authorization: Bearer `.
typestring
expireTime
descriptionTime at which the generated token will expire.
formatgoogle-datetime
typestring
typeobject
GoogleProtobufEmpty
descriptionA 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); }
idGoogleProtobufEmpty
properties
typeobject
Host
descriptionRuntime host for a workstation.
idHost
properties
gceInstance
$refGceInstance
descriptionSpecifies a Compute Engine instance as the host.
typeobject
ListLocationsResponse
descriptionThe response message for Locations.ListLocations.
idListLocationsResponse
properties
locations
descriptionA list of locations that matches the specified filter in the request.
items
$refLocation
typearray
nextPageToken
descriptionThe standard List next-page token.
typestring
typeobject
ListOperationsResponse
descriptionThe response message for Operations.ListOperations.
idListOperationsResponse
properties
nextPageToken
descriptionThe standard List next-page token.
typestring
operations
descriptionA list of operations that matches the specified filter in the request.
items
$refOperation
typearray
typeobject
ListUsableWorkstationConfigsResponse
descriptionResponse message for ListUsableWorkstationConfigs.
idListUsableWorkstationConfigsResponse
properties
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionUnreachable resources.
items
typestring
typearray
workstationConfigs
descriptionThe requested configs.
items
$refWorkstationConfig
typearray
typeobject
ListUsableWorkstationsResponse
descriptionResponse message for ListUsableWorkstations.
idListUsableWorkstationsResponse
properties
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionUnreachable resources.
items
typestring
typearray
workstations
descriptionThe requested workstations.
items
$refWorkstation
typearray
typeobject
ListWorkstationClustersResponse
descriptionResponse message for ListWorkstationClusters.
idListWorkstationClustersResponse
properties
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionUnreachable resources.
items
typestring
typearray
workstationClusters
descriptionThe requested workstation clusters.
items
$refWorkstationCluster
typearray
typeobject
ListWorkstationConfigsResponse
descriptionResponse message for ListWorkstationConfigs.
idListWorkstationConfigsResponse
properties
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionUnreachable resources.
items
typestring
typearray
workstationConfigs
descriptionThe requested configs.
items
$refWorkstationConfig
typearray
typeobject
ListWorkstationsResponse
descriptionResponse message for ListWorkstations.
idListWorkstationsResponse
properties
nextPageToken
descriptionOptional. Token to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionOptional. Unreachable resources.
items
typestring
typearray
workstations
descriptionThe requested workstations.
items
$refWorkstation
typearray
typeobject
Location
descriptionA resource that represents a Google Cloud location.
idLocation
properties
displayName
descriptionThe friendly name for this location, typically a nearby city name. For example, "Tokyo".
typestring
labels
additionalProperties
typestring
descriptionCross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
typeobject
locationId
descriptionThe canonical id for this location. For example: `"us-east1"`.
typestring
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata. For example the available capacity at the given location.
typeobject
name
descriptionResource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
typestring
typeobject
Operation
descriptionThis resource represents a long-running operation that is the result of a network API call.
idOperation
properties
done
descriptionIf the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
typeboolean
error
$refStatus
descriptionThe error result of the operation in case of failure or cancellation.
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
typeobject
name
descriptionThe server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
typestring
response
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionThe normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
typeobject
typeobject
OperationMetadata
descriptionMetadata for long-running operations.
idOperationMetadata
properties
apiVersion
descriptionOutput only. API version used to start the operation.
readOnlyTrue
typestring
createTime
descriptionOutput only. Time that the operation was created.
formatgoogle-datetime
readOnlyTrue
typestring
endTime
descriptionOutput only. Time that the operation finished running.
formatgoogle-datetime
readOnlyTrue
typestring
requestedCancellation
descriptionOutput only. Identifies whether the user has requested cancellation of the operation.
readOnlyTrue
typeboolean
statusMessage
descriptionOutput only. Human-readable status of the operation, if any.
readOnlyTrue
typestring
target
descriptionOutput only. Server-defined resource path for the target of the operation.
readOnlyTrue
typestring
verb
descriptionOutput only. Name of the verb executed by the operation.
readOnlyTrue
typestring
typeobject
PersistentDirectory
descriptionA directory to persist across workstation sessions. Updates to this field will not update existing workstations and will only take effect on new workstations.
idPersistentDirectory
properties
gcePd
$refGceRegionalPersistentDisk
descriptionA PersistentDirectory backed by a Compute Engine persistent disk.
mountPath
descriptionOptional. Location of this directory in the running workstation.
typestring
typeobject
Policy
descriptionAn 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/).
idPolicy
properties
auditConfigs
descriptionSpecifies cloud audit logging configuration for this policy.
items
$refAuditConfig
typearray
bindings
descriptionAssociates 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`.
items
$refBinding
typearray
etag
description`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.
formatbyte
typestring
version
descriptionSpecifies 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).
formatint32
typeinteger
typeobject
PortRange
descriptionA PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.
idPortRange
properties
first
descriptionRequired. Starting port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535.
formatint32
typeinteger
last
descriptionRequired. Ending port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535.
formatint32
typeinteger
typeobject
PrivateClusterConfig
descriptionConfiguration options for private workstation clusters.
idPrivateClusterConfig
properties
allowedProjects
descriptionOptional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.
items
typestring
typearray
clusterHostname
descriptionOutput only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
readOnlyTrue
typestring
enablePrivateEndpoint
descriptionImmutable. Whether Workstations endpoint is private.
typeboolean
serviceAttachmentUri
descriptionOutput only. Service attachment URI for the workstation cluster. The service attachment is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
readOnlyTrue
typestring
typeobject
ReadinessCheck
descriptionA readiness check to be performed on a workstation.
idReadinessCheck
properties
path
descriptionOptional. Path to which the request should be sent.
typestring
port
descriptionOptional. Port to which the request should be sent.
formatint32
typeinteger
typeobject
RuntimeHost
descriptionRuntime host for the workstation.
idRuntimeHost
properties
gceInstanceHost
$refGceInstanceHost
descriptionSpecifies a Compute Engine instance as the host.
typeobject
SetIamPolicyRequest
descriptionRequest message for `SetIamPolicy` method.
idSetIamPolicyRequest
properties
policy
$refPolicy
descriptionREQUIRED: 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 a valid policy but certain Google Cloud services (such as Projects) might reject them.
updateMask
descriptionOPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
formatgoogle-fieldmask
typestring
typeobject
StartWorkstationRequest
descriptionRequest message for StartWorkstation.
idStartWorkstationRequest
properties
boostConfig
descriptionOptional. If set, the workstation starts using the boost configuration with the specified ID.
typestring
etag
descriptionOptional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
typeboolean
typeobject
Status
descriptionThe `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).
idStatus
properties
code
descriptionThe status code, which should be an enum value of google.rpc.Code.
formatint32
typeinteger
details
descriptionA list of messages that carry the error details. There is a common set of message types for APIs to use.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
message
descriptionA 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.
typestring
typeobject
StopWorkstationRequest
descriptionRequest message for StopWorkstation.
idStopWorkstationRequest
properties
etag
descriptionOptional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
typeboolean
typeobject
TestIamPermissionsRequest
descriptionRequest message for `TestIamPermissions` method.
idTestIamPermissionsRequest
properties
permissions
descriptionThe set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
items
typestring
typearray
typeobject
TestIamPermissionsResponse
descriptionResponse message for `TestIamPermissions` method.
idTestIamPermissionsResponse
properties
permissions
descriptionA subset of `TestPermissionsRequest.permissions` that the caller is allowed.
items
typestring
typearray
typeobject
Workstation
descriptionA single instance of a developer workstation with its own persistent storage.
idWorkstation
properties
annotations
additionalProperties
typestring
descriptionOptional. Client-specified annotations.
typeobject
createTime
descriptionOutput only. Time when this workstation was created.
formatgoogle-datetime
readOnlyTrue
typestring
deleteTime
descriptionOutput only. Time when this workstation was soft-deleted.
formatgoogle-datetime
readOnlyTrue
typestring
displayName
descriptionOptional. Human-readable name for this workstation.
typestring
env
additionalProperties
typestring
descriptionOptional. Environment variables passed to the workstation container's entrypoint.
typeobject
etag
descriptionOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
typestring
host
descriptionOutput only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`.
readOnlyTrue
typestring
kmsKey
descriptionOutput only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
readOnlyTrue
typestring
labels
additionalProperties
typestring
descriptionOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.
typeobject
name
descriptionIdentifier. Full name of this workstation.
typestring
reconciling
descriptionOutput only. Indicates whether this workstation is currently being updated to match its intended state.
readOnlyTrue
typeboolean
runtimeHost
$refRuntimeHost
descriptionOptional. Output only. Runtime host for the workstation when in STATE_RUNNING.
readOnlyTrue
sourceWorkstation
descriptionOptional. The source workstation from which this workstation's persistent directories were cloned on creation.
typestring
startTime
descriptionOutput only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.
formatgoogle-datetime
readOnlyTrue
typestring
state
descriptionOutput only. Current state of the workstation.
enum
  • STATE_UNSPECIFIED
  • STATE_STARTING
  • STATE_RUNNING
  • STATE_STOPPING
  • STATE_STOPPED
enumDescriptions
  • Do not use.
  • The workstation is not yet ready to accept requests from users but will be soon.
  • The workstation is ready to accept requests from users.
  • The workstation is being stopped.
  • The workstation is stopped and will not be able to receive requests until it is started.
readOnlyTrue
typestring
uid
descriptionOutput only. A system-assigned unique identifier for this workstation.
readOnlyTrue
typestring
updateTime
descriptionOutput only. Time when this workstation was most recently updated.
formatgoogle-datetime
readOnlyTrue
typestring
typeobject
WorkstationCluster
descriptionA workstation cluster resource in the Cloud Workstations API. Defines a group of workstations in a particular region and the VPC network they're attached to.
idWorkstationCluster
properties
annotations
additionalProperties
typestring
descriptionOptional. Client-specified annotations.
typeobject
conditions
descriptionOutput only. Status conditions describing the workstation cluster's current state.
items
$refStatus
readOnlyTrue
typearray
controlPlaneIp
descriptionOutput only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.
readOnlyTrue
typestring
createTime
descriptionOutput only. Time when this workstation cluster was created.
formatgoogle-datetime
readOnlyTrue
typestring
degraded
descriptionOutput only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
readOnlyTrue
typeboolean
deleteTime
descriptionOutput only. Time when this workstation cluster was soft-deleted.
formatgoogle-datetime
readOnlyTrue
typestring
displayName
descriptionOptional. Human-readable name for this workstation cluster.
typestring
domainConfig
$refDomainConfig
descriptionOptional. Configuration options for a custom domain.
etag
descriptionOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
typestring
labels
additionalProperties
typestring
descriptionOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
typeobject
name
descriptionIdentifier. Full name of this workstation cluster.
typestring
network
descriptionImmutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
typestring
privateClusterConfig
$refPrivateClusterConfig
descriptionOptional. Configuration for private workstation cluster.
reconciling
descriptionOutput only. Indicates whether this workstation cluster is currently being updated to match its intended state.
readOnlyTrue
typeboolean
subnetwork
descriptionImmutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.
typestring
tags
additionalProperties
typestring
descriptionOptional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
typeobject
uid
descriptionOutput only. A system-assigned unique identifier for this workstation cluster.
readOnlyTrue
typestring
updateTime
descriptionOutput only. Time when this workstation cluster was most recently updated.
formatgoogle-datetime
readOnlyTrue
typestring
typeobject
WorkstationConfig
descriptionA workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers.
idWorkstationConfig
properties
allowedPorts
descriptionOptional. A list of PortRanges specifying single ports or ranges of ports that are externally accessible in the workstation. Allowed ports must be one of 22, 80, or within range 1024-65535. If not specified defaults to ports 22, 80, and ports 1024-65535.
items
$refPortRange
typearray
annotations
additionalProperties
typestring
descriptionOptional. Client-specified annotations.
typeobject
conditions
descriptionOutput only. Status conditions describing the current resource state.
items
$refStatus
readOnlyTrue
typearray
container
$refContainer
descriptionOptional. Container that runs upon startup for each workstation using this workstation configuration.
createTime
descriptionOutput only. Time when this workstation configuration was created.
formatgoogle-datetime
readOnlyTrue
typestring
degraded
descriptionOutput only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
readOnlyTrue
typeboolean
deleteTime
descriptionOutput only. Time when this workstation configuration was soft-deleted.
formatgoogle-datetime
readOnlyTrue
typestring
disableTcpConnections
descriptionOptional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS.
typeboolean
displayName
descriptionOptional. Human-readable name for this workstation configuration.
typestring
enableAuditAgent
descriptionOptional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](https://cloud.google.com/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd"
typeboolean
encryptionKey
$refCustomerEncryptionKey
descriptionImmutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created.
ephemeralDirectories
descriptionOptional. Ephemeral directories which won't persist across workstation sessions.
items
$refEphemeralDirectory
typearray
etag
descriptionOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
typestring
grantWorkstationAdminRoleOnCreate
descriptionOptional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false.
typeboolean
host
$refHost
descriptionOptional. Runtime host for the workstation.
idleTimeout
descriptionOptional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes).
formatgoogle-duration
typestring
labels
additionalProperties
typestring
descriptionOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
typeobject
maxUsableWorkstations
descriptionOptional. Maximum number of workstations under this configuration a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified, defaults to `0`, which indicates unlimited.
formatint32
typeinteger
name
descriptionIdentifier. Full name of this workstation configuration.
typestring
persistentDirectories
descriptionOptional. Directories to persist across workstation sessions.
items
$refPersistentDirectory
typearray
readinessChecks
descriptionOptional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
items
$refReadinessCheck
typearray
reconciling
descriptionOutput only. Indicates whether this workstation configuration is currently being updated to match its intended state.
readOnlyTrue
typeboolean
replicaZones
descriptionOptional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created.
items
typestring
typearray
runningTimeout
descriptionOptional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.
formatgoogle-duration
typestring
uid
descriptionOutput only. A system-assigned unique identifier for this workstation configuration.
readOnlyTrue
typestring
updateTime
descriptionOutput only. Time when this workstation configuration was most recently updated.
formatgoogle-datetime
readOnlyTrue
typestring
typeobject
servicePath
titleCloud Workstations API (staging)
versionv1
version_moduleTrue
old_value
error
code403
details
  • @typetype.googleapis.com/google.rpc.Help
    links
    descriptionurl
    Google developers console API activationhttps://console.developers.google.com/apis/api/staging-workstations.sandbox.googleapis.com/overview?project=858541998083
  • @typetype.googleapis.com/google.rpc.ErrorInfo
    domaingoogleapis.com
    metadata
    consumerprojects/858541998083
    servicestaging-workstations.sandbox.googleapis.com
    reasonSERVICE_DISABLED
messageCloud Workstations API (staging) has not been used in project 858541998083 before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/staging-workstations.sandbox.googleapis.com/overview?project=858541998083 then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.
statusPERMISSION_DENIED
sandbox/staging-workstations-v1alpha
values_changed
root
new_value
auth
oauth2
scopes
https://www.googleapis.com/auth/cloud-platform
descriptionSee, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
basePath
baseUrlhttps://staging-workstations.sandbox.googleapis.com/
batchPathbatch
canonicalNameCloud Workstations
descriptionAllows administrators to create managed developer environments in the cloud.
discoveryVersionv1
documentationLinkhttps://cloud.google.com/workstations
fullyEncodeReservedExpansionTrue
icons
x16http://www.google.com/images/icons/product/search-16.gif
x32http://www.google.com/images/icons/product/search-32.gif
idworkstations:v1alpha
kinddiscovery#restDescription
mtlsRootUrlhttps://staging-workstations.mtls.sandbox.googleapis.com/
nameworkstations
ownerDomaingoogle.com
ownerNameGoogle
parameters
$.xgafv
descriptionV1 error format.
enum
  • 1
  • 2
enumDescriptions
  • v1 error format
  • v2 error format
locationquery
typestring
access_token
descriptionOAuth access token.
locationquery
typestring
alt
defaultjson
descriptionData format for response.
enum
  • json
  • media
  • proto
enumDescriptions
  • Responses with Content-Type of application/json
  • Media download with context-dependent Content-Type
  • Responses with Content-Type of application/x-protobuf
locationquery
typestring
callback
descriptionJSONP
locationquery
typestring
fields
descriptionSelector specifying which fields to include in a partial response.
locationquery
typestring
key
descriptionAPI key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
locationquery
typestring
oauth_token
descriptionOAuth 2.0 token for the current user.
locationquery
typestring
prettyPrint
defaulttrue
descriptionReturns response with indentations and line breaks.
locationquery
typeboolean
quotaUser
descriptionAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
locationquery
typestring
uploadType
descriptionLegacy upload protocol for media (e.g. "media", "multipart").
locationquery
typestring
upload_protocol
descriptionUpload protocol for media (e.g. "raw", "multipart").
locationquery
typestring
protocolrest
resources
projects
resources
locations
resources
operations
methods
cancel
descriptionStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
flatPathv1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
httpMethodPOST
idworkstations.projects.locations.operations.cancel
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource to be cancelled.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1alpha/{+name}:cancel
request
$refCancelOperationRequest
response
$refGoogleProtobufEmpty
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
flatPathv1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
httpMethodDELETE
idworkstations.projects.locations.operations.delete
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource to be deleted.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1alpha/{+name}
response
$refGoogleProtobufEmpty
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
flatPathv1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
httpMethodGET
idworkstations.projects.locations.operations.get
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1alpha/{+name}
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
flatPathv1alpha/projects/{projectsId}/locations/{locationsId}/operations
httpMethodGET
idworkstations.projects.locations.operations.list
parameterOrder
  • name
parameters
filter
descriptionThe standard list filter.
locationquery
typestring
name
descriptionThe name of the operation's parent resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
pageSize
descriptionThe standard list page size.
formatint32
locationquery
typeinteger
pageToken
descriptionThe standard list page token.
locationquery
typestring
pathv1alpha/{+name}/operations
response
$refListOperationsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
workstationClusters
resources
workstationConfigs
methods
getIamPolicy
descriptionGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
flatPathv1alpha/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:getIamPolicy
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.getIamPolicy
parameterOrder
  • resource
parameters
options.requestedPolicyVersion
descriptionOptional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
formatint32
locationquery
typeinteger
resource
descriptionREQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1alpha/{+resource}:getIamPolicy
response
$refPolicy
scopes
  • https://www.googleapis.com/auth/cloud-platform
setIamPolicy
descriptionSets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
flatPathv1alpha/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:setIamPolicy
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.setIamPolicy
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1alpha/{+resource}:setIamPolicy
request
$refSetIamPolicyRequest
response
$refPolicy
scopes
  • https://www.googleapis.com/auth/cloud-platform
testIamPermissions
descriptionReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
flatPathv1alpha/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:testIamPermissions
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.testIamPermissions
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1alpha/{+resource}:testIamPermissions
request
$refTestIamPermissionsRequest
response
$refTestIamPermissionsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
resources
workstations
methods
getIamPolicy
descriptionGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
flatPathv1alpha/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:getIamPolicy
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.getIamPolicy
parameterOrder
  • resource
parameters
options.requestedPolicyVersion
descriptionOptional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
formatint32
locationquery
typeinteger
resource
descriptionREQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1alpha/{+resource}:getIamPolicy
response
$refPolicy
scopes
  • https://www.googleapis.com/auth/cloud-platform
setIamPolicy
descriptionSets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
flatPathv1alpha/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:setIamPolicy
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.setIamPolicy
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1alpha/{+resource}:setIamPolicy
request
$refSetIamPolicyRequest
response
$refPolicy
scopes
  • https://www.googleapis.com/auth/cloud-platform
testIamPermissions
descriptionReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
flatPathv1alpha/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:testIamPermissions
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.testIamPermissions
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1alpha/{+resource}:testIamPermissions
request
$refTestIamPermissionsRequest
response
$refTestIamPermissionsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
revision20250217
rootUrlhttps://staging-workstations.sandbox.googleapis.com/
schemas
AuditConfig
descriptionSpecifies 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.
idAuditConfig
properties
auditLogConfigs
descriptionThe configuration for logging of each type of permission.
items
$refAuditLogConfig
typearray
service
descriptionSpecifies 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.
typestring
typeobject
AuditLogConfig
descriptionProvides 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.
idAuditLogConfig
properties
exemptedMembers
descriptionSpecifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
items
typestring
typearray
logType
descriptionThe log type that this config enables.
enum
  • LOG_TYPE_UNSPECIFIED
  • ADMIN_READ
  • DATA_WRITE
  • DATA_READ
enumDescriptions
  • Default case. Should never be this.
  • Admin reads. Example: CloudIAM getIamPolicy
  • Data writes. Example: CloudSQL Users create
  • Data reads. Example: CloudSQL Users list
typestring
typeobject
Binding
descriptionAssociates `members`, or principals, with a `role`.
idBinding
properties
condition
$refExpr
descriptionThe 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).
members
descriptionSpecifies 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`.
items
typestring
typearray
role
descriptionRole 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).
typestring
typeobject
CancelOperationRequest
descriptionThe request message for Operations.CancelOperation.
idCancelOperationRequest
properties
typeobject
Expr
descriptionRepresents 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.
idExpr
properties
description
descriptionOptional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
typestring
expression
descriptionTextual representation of an expression in Common Expression Language syntax.
typestring
location
descriptionOptional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
typestring
title
descriptionOptional. 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.
typestring
typeobject
GoogleProtobufEmpty
descriptionA 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); }
idGoogleProtobufEmpty
properties
typeobject
ListOperationsResponse
descriptionThe response message for Operations.ListOperations.
idListOperationsResponse
properties
nextPageToken
descriptionThe standard List next-page token.
typestring
operations
descriptionA list of operations that matches the specified filter in the request.
items
$refOperation
typearray
typeobject
Operation
descriptionThis resource represents a long-running operation that is the result of a network API call.
idOperation
properties
done
descriptionIf the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
typeboolean
error
$refStatus
descriptionThe error result of the operation in case of failure or cancellation.
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
typeobject
name
descriptionThe server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
typestring
response
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionThe normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
typeobject
typeobject
Policy
descriptionAn 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/).
idPolicy
properties
auditConfigs
descriptionSpecifies cloud audit logging configuration for this policy.
items
$refAuditConfig
typearray
bindings
descriptionAssociates 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`.
items
$refBinding
typearray
etag
description`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.
formatbyte
typestring
version
descriptionSpecifies 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).
formatint32
typeinteger
typeobject
SetIamPolicyRequest
descriptionRequest message for `SetIamPolicy` method.
idSetIamPolicyRequest
properties
policy
$refPolicy
descriptionREQUIRED: 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 a valid policy but certain Google Cloud services (such as Projects) might reject them.
updateMask
descriptionOPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
formatgoogle-fieldmask
typestring
typeobject
Status
descriptionThe `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).
idStatus
properties
code
descriptionThe status code, which should be an enum value of google.rpc.Code.
formatint32
typeinteger
details
descriptionA list of messages that carry the error details. There is a common set of message types for APIs to use.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
message
descriptionA 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.
typestring
typeobject
TestIamPermissionsRequest
descriptionRequest message for `TestIamPermissions` method.
idTestIamPermissionsRequest
properties
permissions
descriptionThe set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
items
typestring
typearray
typeobject
TestIamPermissionsResponse
descriptionResponse message for `TestIamPermissions` method.
idTestIamPermissionsResponse
properties
permissions
descriptionA subset of `TestPermissionsRequest.permissions` that the caller is allowed.
items
typestring
typearray
typeobject
servicePath
titleCloud Workstations API (staging)
versionv1alpha
version_moduleTrue
old_value
error
code403
details
  • @typetype.googleapis.com/google.rpc.Help
    links
    descriptionurl
    Google developers console API activationhttps://console.developers.google.com/apis/api/staging-workstations.sandbox.googleapis.com/overview?project=292824132082
  • @typetype.googleapis.com/google.rpc.ErrorInfo
    domaingoogleapis.com
    metadata
    consumerprojects/292824132082
    servicestaging-workstations.sandbox.googleapis.com
    reasonSERVICE_DISABLED
messageCloud Workstations API (staging) has not been used in project 292824132082 before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/staging-workstations.sandbox.googleapis.com/overview?project=292824132082 then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.
statusPERMISSION_DENIED
sandbox/staging-workstations-v1beta
values_changed
root
new_value
auth
oauth2
scopes
https://www.googleapis.com/auth/cloud-platform
descriptionSee, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
basePath
baseUrlhttps://staging-workstations.sandbox.googleapis.com/
batchPathbatch
canonicalNameCloud Workstations
descriptionAllows administrators to create managed developer environments in the cloud.
discoveryVersionv1
documentationLinkhttps://cloud.google.com/workstations
fullyEncodeReservedExpansionTrue
icons
x16http://www.google.com/images/icons/product/search-16.gif
x32http://www.google.com/images/icons/product/search-32.gif
idworkstations:v1beta
kinddiscovery#restDescription
mtlsRootUrlhttps://staging-workstations.mtls.sandbox.googleapis.com/
nameworkstations
ownerDomaingoogle.com
ownerNameGoogle
parameters
$.xgafv
descriptionV1 error format.
enum
  • 1
  • 2
enumDescriptions
  • v1 error format
  • v2 error format
locationquery
typestring
access_token
descriptionOAuth access token.
locationquery
typestring
alt
defaultjson
descriptionData format for response.
enum
  • json
  • media
  • proto
enumDescriptions
  • Responses with Content-Type of application/json
  • Media download with context-dependent Content-Type
  • Responses with Content-Type of application/x-protobuf
locationquery
typestring
callback
descriptionJSONP
locationquery
typestring
fields
descriptionSelector specifying which fields to include in a partial response.
locationquery
typestring
key
descriptionAPI key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
locationquery
typestring
oauth_token
descriptionOAuth 2.0 token for the current user.
locationquery
typestring
prettyPrint
defaulttrue
descriptionReturns response with indentations and line breaks.
locationquery
typeboolean
quotaUser
descriptionAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
locationquery
typestring
uploadType
descriptionLegacy upload protocol for media (e.g. "media", "multipart").
locationquery
typestring
upload_protocol
descriptionUpload protocol for media (e.g. "raw", "multipart").
locationquery
typestring
protocolrest
resources
projects
resources
locations
resources
operations
methods
cancel
descriptionStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
httpMethodPOST
idworkstations.projects.locations.operations.cancel
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource to be cancelled.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1beta/{+name}:cancel
request
$refCancelOperationRequest
response
$refGoogleProtobufEmpty
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
httpMethodDELETE
idworkstations.projects.locations.operations.delete
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource to be deleted.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1beta/{+name}
response
$refGoogleProtobufEmpty
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
httpMethodGET
idworkstations.projects.locations.operations.get
parameterOrder
  • name
parameters
name
descriptionThe name of the operation resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+/operations/[^/]+$
requiredTrue
typestring
pathv1beta/{+name}
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/operations
httpMethodGET
idworkstations.projects.locations.operations.list
parameterOrder
  • name
parameters
filter
descriptionThe standard list filter.
locationquery
typestring
name
descriptionThe name of the operation's parent resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
pageSize
descriptionThe standard list page size.
formatint32
locationquery
typeinteger
pageToken
descriptionThe standard list page token.
locationquery
typestring
pathv1beta/{+name}/operations
response
$refListOperationsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
workstationClusters
methods
create
descriptionCreates a new workstation cluster.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters
httpMethodPOST
idworkstations.projects.locations.workstationClusters.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
workstationClusterId
descriptionRequired. ID to use for the workstation cluster.
locationquery
typestring
pathv1beta/{+parent}/workstationClusters
request
$refWorkstationCluster
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes the specified workstation cluster.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
httpMethodDELETE
idworkstations.projects.locations.workstationClusters.delete
parameterOrder
  • name
parameters
etag
descriptionOptional. If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag.
locationquery
typestring
force
descriptionOptional. If set, any workstation configurations and workstations in the workstation cluster are also deleted. Otherwise, the request only works if the workstation cluster has no configurations or workstations.
locationquery
typeboolean
name
descriptionRequired. Name of the workstation cluster to delete.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
requiredTrue
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not apply it.
locationquery
typeboolean
pathv1beta/{+name}
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionReturns the requested workstation cluster.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
httpMethodGET
idworkstations.projects.locations.workstationClusters.get
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the requested resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
requiredTrue
typestring
pathv1beta/{+name}
response
$refWorkstationCluster
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionReturns all workstation clusters in the specified location.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters
httpMethodGET
idworkstations.projects.locations.workstationClusters.list
parameterOrder
  • parent
parameters
pageSize
descriptionOptional. Maximum number of items to return.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. next_page_token value returned from a previous List request, if any.
locationquery
typestring
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+$
requiredTrue
typestring
pathv1beta/{+parent}/workstationClusters
response
$refListWorkstationClustersResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
patch
descriptionUpdates an existing workstation cluster.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}
httpMethodPATCH
idworkstations.projects.locations.workstationClusters.patch
parameterOrder
  • name
parameters
allowMissing
descriptionOptional. If set, and the workstation cluster is not found, a new workstation cluster will be created. In this situation, update_mask is ignored.
locationquery
typeboolean
name
descriptionIdentifier. Full name of this workstation cluster.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired. Mask that specifies which fields in the workstation cluster should be updated.
formatgoogle-fieldmask
locationquery
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
pathv1beta/{+name}
request
$refWorkstationCluster
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
resources
workstationConfigs
methods
create
descriptionCreates a new workstation configuration.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
requiredTrue
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
workstationConfigId
descriptionRequired. ID to use for the workstation configuration.
locationquery
typestring
pathv1beta/{+parent}/workstationConfigs
request
$refWorkstationConfig
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes the specified workstation configuration.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
httpMethodDELETE
idworkstations.projects.locations.workstationClusters.workstationConfigs.delete
parameterOrder
  • name
parameters
etag
descriptionOptional. If set, the request is rejected if the latest version of the workstation configuration on the server does not have this ETag.
locationquery
typestring
force
descriptionOptional. If set, any workstations in the workstation configuration are also deleted. Otherwise, the request works only if the workstation configuration has no workstations.
locationquery
typeboolean
name
descriptionRequired. Name of the workstation configuration to delete.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
pathv1beta/{+name}
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionReturns the requested workstation configuration.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.get
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the requested resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1beta/{+name}
response
$refWorkstationConfig
scopes
  • https://www.googleapis.com/auth/cloud-platform
getIamPolicy
descriptionGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:getIamPolicy
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.getIamPolicy
parameterOrder
  • resource
parameters
options.requestedPolicyVersion
descriptionOptional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
formatint32
locationquery
typeinteger
resource
descriptionREQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1beta/{+resource}:getIamPolicy
response
$refPolicy
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionReturns all workstation configurations in the specified cluster.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.list
parameterOrder
  • parent
parameters
pageSize
descriptionOptional. Maximum number of items to return.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. next_page_token value returned from a previous List request, if any.
locationquery
typestring
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
requiredTrue
typestring
pathv1beta/{+parent}/workstationConfigs
response
$refListWorkstationConfigsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
listUsable
descriptionReturns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs:listUsable
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.listUsable
parameterOrder
  • parent
parameters
pageSize
descriptionOptional. Maximum number of items to return.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. next_page_token value returned from a previous List request, if any.
locationquery
typestring
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+$
requiredTrue
typestring
pathv1beta/{+parent}/workstationConfigs:listUsable
response
$refListUsableWorkstationConfigsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
patch
descriptionUpdates an existing workstation configuration.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}
httpMethodPATCH
idworkstations.projects.locations.workstationClusters.workstationConfigs.patch
parameterOrder
  • name
parameters
allowMissing
descriptionOptional. If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored.
locationquery
typeboolean
name
descriptionIdentifier. Full name of this workstation configuration.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired. Mask specifying which fields in the workstation configuration should be updated.
formatgoogle-fieldmask
locationquery
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
pathv1beta/{+name}
request
$refWorkstationConfig
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
setIamPolicy
descriptionSets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:setIamPolicy
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.setIamPolicy
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1beta/{+resource}:setIamPolicy
request
$refSetIamPolicyRequest
response
$refPolicy
scopes
  • https://www.googleapis.com/auth/cloud-platform
testIamPermissions
descriptionReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}:testIamPermissions
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.testIamPermissions
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1beta/{+resource}:testIamPermissions
request
$refTestIamPermissionsRequest
response
$refTestIamPermissionsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
resources
workstations
methods
create
descriptionCreates a new workstation.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.create
parameterOrder
  • parent
parameters
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
workstationId
descriptionRequired. ID to use for the workstation.
locationquery
typestring
pathv1beta/{+parent}/workstations
request
$refWorkstation
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes the specified workstation.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
httpMethodDELETE
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.delete
parameterOrder
  • name
parameters
etag
descriptionOptional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
locationquery
typestring
name
descriptionRequired. Name of the workstation to delete.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
pathv1beta/{+name}
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
generateAccessToken
descriptionReturns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation. Once generated this token cannot be revoked and is good for the lifetime of the token.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:generateAccessToken
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.generateAccessToken
parameterOrder
  • workstation
parameters
workstation
descriptionRequired. Name of the workstation for which the access token should be generated.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1beta/{+workstation}:generateAccessToken
request
$refGenerateAccessTokenRequest
response
$refGenerateAccessTokenResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionReturns the requested workstation.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.get
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the requested resource.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1beta/{+name}
response
$refWorkstation
scopes
  • https://www.googleapis.com/auth/cloud-platform
getIamPolicy
descriptionGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:getIamPolicy
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.getIamPolicy
parameterOrder
  • resource
parameters
options.requestedPolicyVersion
descriptionOptional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
formatint32
locationquery
typeinteger
resource
descriptionREQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1beta/{+resource}:getIamPolicy
response
$refPolicy
scopes
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionReturns all Workstations using the specified workstation configuration.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.list
parameterOrder
  • parent
parameters
pageSize
descriptionOptional. Maximum number of items to return.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. next_page_token value returned from a previous List request, if any.
locationquery
typestring
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1beta/{+parent}/workstations
response
$refListWorkstationsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
listUsable
descriptionReturns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations:listUsable
httpMethodGET
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.listUsable
parameterOrder
  • parent
parameters
pageSize
descriptionOptional. Maximum number of items to return.
formatint32
locationquery
typeinteger
pageToken
descriptionOptional. next_page_token value returned from a previous List request, if any.
locationquery
typestring
parent
descriptionRequired. Parent resource name.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+$
requiredTrue
typestring
pathv1beta/{+parent}/workstations:listUsable
response
$refListUsableWorkstationsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
patch
descriptionUpdates an existing workstation.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}
httpMethodPATCH
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.patch
parameterOrder
  • name
parameters
allowMissing
descriptionOptional. If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored.
locationquery
typeboolean
name
descriptionIdentifier. Full name of this workstation.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired. Mask specifying which fields in the workstation configuration should be updated.
formatgoogle-fieldmask
locationquery
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
locationquery
typeboolean
pathv1beta/{+name}
request
$refWorkstation
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
setIamPolicy
descriptionSets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:setIamPolicy
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.setIamPolicy
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1beta/{+resource}:setIamPolicy
request
$refSetIamPolicyRequest
response
$refPolicy
scopes
  • https://www.googleapis.com/auth/cloud-platform
start
descriptionStarts running a workstation so that users can connect to it.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:start
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.start
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the workstation to start.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1beta/{+name}:start
request
$refStartWorkstationRequest
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
stop
descriptionStops running a workstation, reducing costs.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:stop
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.stop
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the workstation to stop.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1beta/{+name}:stop
request
$refStopWorkstationRequest
response
$refOperation
scopes
  • https://www.googleapis.com/auth/cloud-platform
testIamPermissions
descriptionReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
flatPathv1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:testIamPermissions
httpMethodPOST
idworkstations.projects.locations.workstationClusters.workstationConfigs.workstations.testIamPermissions
parameterOrder
  • resource
parameters
resource
descriptionREQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
locationpath
pattern^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$
requiredTrue
typestring
pathv1beta/{+resource}:testIamPermissions
request
$refTestIamPermissionsRequest
response
$refTestIamPermissionsResponse
scopes
  • https://www.googleapis.com/auth/cloud-platform
revision20250217
rootUrlhttps://staging-workstations.sandbox.googleapis.com/
schemas
Accelerator
descriptionAn accelerator card attached to the instance.
idAccelerator
properties
count
descriptionOptional. Number of accelerator cards exposed to the instance.
formatint32
typeinteger
type
descriptionOptional. Type of accelerator resource to attach to the instance, for example, `"nvidia-tesla-p100"`.
typestring
typeobject
AuditConfig
descriptionSpecifies 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.
idAuditConfig
properties
auditLogConfigs
descriptionThe configuration for logging of each type of permission.
items
$refAuditLogConfig
typearray
service
descriptionSpecifies 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.
typestring
typeobject
AuditLogConfig
descriptionProvides 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.
idAuditLogConfig
properties
exemptedMembers
descriptionSpecifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
items
typestring
typearray
logType
descriptionThe log type that this config enables.
enum
  • LOG_TYPE_UNSPECIFIED
  • ADMIN_READ
  • DATA_WRITE
  • DATA_READ
enumDescriptions
  • Default case. Should never be this.
  • Admin reads. Example: CloudIAM getIamPolicy
  • Data writes. Example: CloudSQL Users create
  • Data reads. Example: CloudSQL Users list
typestring
typeobject
Binding
descriptionAssociates `members`, or principals, with a `role`.
idBinding
properties
condition
$refExpr
descriptionThe 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).
members
descriptionSpecifies 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`.
items
typestring
typearray
role
descriptionRole 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).
typestring
typeobject
BoostConfig
descriptionA boost configuration is a set of resources that a workstation can use to increase its performance. If you specify a boost configuration, upon startup, workstation users can choose to use a VM provisioned under the boost config by passing the boost config ID in the start request. If the workstation user does not provide a boost config ID in the start request, the system will choose a VM from the pool provisioned under the default config.
idBoostConfig
properties
accelerators
descriptionOptional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to `none`.
items
$refAccelerator
typearray
bootDiskSizeGb
descriptionOptional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB.
formatint32
typeinteger
enableNestedVirtualization
descriptionOptional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series.
typeboolean
id
descriptionRequired. The ID to be used for the boost configuration.
typestring
machineType
descriptionOptional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`.
typestring
poolSize
descriptionOptional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`.
formatint32
typeinteger
typeobject
CancelOperationRequest
descriptionThe request message for Operations.CancelOperation.
idCancelOperationRequest
properties
typeobject
Container
descriptionA Docker container.
idContainer
properties
args
descriptionOptional. Arguments passed to the entrypoint.
items
typestring
typearray
command
descriptionOptional. If set, overrides the default ENTRYPOINT specified by the image.
items
typestring
typearray
env
additionalProperties
typestring
descriptionOptional. Environment variables passed to the container's entrypoint.
typeobject
image
descriptionOptional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of [preconfigured images](https://cloud.google.com/workstations/docs/preconfigured-base-images), but you can create your own [custom container images](https://cloud.google.com/workstations/docs/custom-container-images). If using a private image, the `host.gceInstance.serviceAccount` field must be specified in the workstation configuration. If using a custom container image, the service account must have [Artifact Registry Reader](https://cloud.google.com/artifact-registry/docs/access-control#roles) permission to pull the specified image. Otherwise, the image must be publicly accessible.
typestring
runAsUser
descriptionOptional. If set, overrides the USER specified in the image with the given uid.
formatint32
typeinteger
workingDir
descriptionOptional. If set, overrides the default DIR specified by the image.
typestring
typeobject
CustomerEncryptionKey
descriptionA customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties).
idCustomerEncryptionKey
properties
kmsKey
descriptionImmutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration.
typestring
kmsKeyServiceAccount
descriptionImmutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member).
typestring
typeobject
DomainConfig
descriptionConfiguration options for a custom domain.
idDomainConfig
properties
domain
descriptionImmutable. Domain used by Workstations for HTTP ingress.
typestring
typeobject
EphemeralDirectory
descriptionAn ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.
idEphemeralDirectory
properties
gcePd
$refGcePersistentDisk
descriptionAn EphemeralDirectory backed by a Compute Engine persistent disk.
mountPath
descriptionRequired. Location of this directory in the running workstation.
typestring
typeobject
Expr
descriptionRepresents 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.
idExpr
properties
description
descriptionOptional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
typestring
expression
descriptionTextual representation of an expression in Common Expression Language syntax.
typestring
location
descriptionOptional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
typestring
title
descriptionOptional. 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.
typestring
typeobject
GceConfidentialInstanceConfig
descriptionA set of Compute Engine Confidential VM instance options.
idGceConfidentialInstanceConfig
properties
enableConfidentialCompute
descriptionOptional. Whether the instance has confidential compute enabled.
typeboolean
typeobject
GceInstance
descriptionA runtime using a Compute Engine instance.
idGceInstance
properties
accelerators
descriptionOptional. A list of the type and count of accelerator cards attached to the instance.
items
$refAccelerator
typearray
boostConfigs
descriptionOptional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
items
$refBoostConfig
typearray
bootDiskSizeGb
descriptionOptional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB.
formatint32
typeinteger
confidentialInstanceConfig
$refGceConfidentialInstanceConfig
descriptionOptional. A set of Compute Engine Confidential VM instance options.
disablePublicIpAddresses
descriptionOptional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses).
typeboolean
disableSsh
descriptionOptional. Whether to disable SSH access to the VM.
typeboolean
enableNestedVirtualization
descriptionOptional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series.
typeboolean
machineType
descriptionOptional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types).
typestring
poolSize
descriptionOptional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API.
formatint32
typeinteger
pooledInstances
descriptionOutput only. Number of instances currently available in the pool for faster workstation startup.
formatint32
readOnlyTrue
typeinteger
serviceAccount
descriptionOptional. The email address of the service account for Cloud Workstations VMs created with this configuration. When specified, be sure that the service account has `logging.logEntries.create` and `monitoring.timeSeries.create` permissions on the project so it can write logs out to Cloud Logging. If using a custom container image, the service account must have [Artifact Registry Reader](https://cloud.google.com/artifact-registry/docs/access-control#roles) permission to pull the specified image. If you as the administrator want to be able to `ssh` into the underlying VM, you need to set this value to a service account for which you have the `iam.serviceAccounts.actAs` permission. Conversely, if you don't want anyone to be able to `ssh` into the underlying VM, use a service account where no one has that permission. If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
typestring
serviceAccountScopes
descriptionOptional. Scopes to grant to the service_account. When specified, users of workstations under this configuration must have `iam.serviceAccounts.actAs` on the service account.
items
typestring
typearray
shieldedInstanceConfig
$refGceShieldedInstanceConfig
descriptionOptional. A set of Compute Engine Shielded instance options.
tags
descriptionOptional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies [network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs created with this configuration. These network tags enable the creation of [firewall rules](https://cloud.google.com/workstations/docs/configure-firewall-rules).
items
typestring
typearray
vmTags
additionalProperties
typestring
descriptionOptional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as [resource manager tags](https://cloud.google.com/resource-manager/docs/tags/tags-overview). Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`.
typeobject
typeobject
GceInstanceHost
descriptionThe Compute Engine instance host.
idGceInstanceHost
properties
id
descriptionOptional. Output only. The ID of the Compute Engine instance.
readOnlyTrue
typestring
name
descriptionOptional. Output only. The name of the Compute Engine instance.
readOnlyTrue
typestring
zone
descriptionOptional. Output only. The zone of the Compute Engine instance.
readOnlyTrue
typestring
typeobject
GcePersistentDisk
descriptionAn EphemeralDirectory is backed by a Compute Engine persistent disk.
idGcePersistentDisk
properties
diskType
descriptionOptional. Type of the disk to use. Defaults to `"pd-standard"`.
typestring
readOnly
descriptionOptional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and source_snapshot must be set.
typeboolean
sourceImage
descriptionOptional. Name of the disk image to use as the source for the disk. Must be empty if source_snapshot is set. Updating source_image will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable.
typestring
sourceSnapshot
descriptionOptional. Name of the snapshot to use as the source for the disk. Must be empty if source_image is set. Must be empty if read_only is false. Updating source_snapshot will update content in the ephemeral directory after the workstation is restarted. Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the [COS documentation](https://cloud.google.com/container-optimized-os/docs/concepts/supported-filesystems). This field is mutable.
typestring
typeobject
GceRegionalPersistentDisk
descriptionA Persistent Directory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a [persistent disk](https://cloud.google.com/compute/docs/disks/persistent-disks) that mounts to the workstation VM at `/home` when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.
idGceRegionalPersistentDisk
properties
diskType
descriptionOptional. The [type of the persistent disk](https://cloud.google.com/compute/docs/disks#disk-types) for the home directory. Defaults to `"pd-standard"`.
typestring
fsType
descriptionOptional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if source_snapshot is set. Defaults to `"ext4"`.
typestring
reclaimPolicy
descriptionOptional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`.
enum
  • RECLAIM_POLICY_UNSPECIFIED
  • DELETE
  • RETAIN
enumDescriptions
  • Do not use.
  • Delete the persistent disk when deleting the workstation.
  • Keep the persistent disk when deleting the workstation. An administrator must manually delete the disk.
typestring
sizeGb
descriptionOptional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. If less than `200` GB, the disk_type must be `"pd-balanced"` or `"pd-ssd"`.
formatint32
typeinteger
sourceSnapshot
descriptionOptional. Name of the snapshot to use as the source for the disk. If set, size_gb and fs_type must be empty.
typestring
typeobject
GceShieldedInstanceConfig
descriptionA set of Compute Engine Shielded instance options.
idGceShieldedInstanceConfig
properties
enableIntegrityMonitoring
descriptionOptional. Whether the instance has integrity monitoring enabled.
typeboolean
enableSecureBoot
descriptionOptional. Whether the instance has Secure Boot enabled.
typeboolean
enableVtpm
descriptionOptional. Whether the instance has the vTPM enabled.
typeboolean
typeobject
GenerateAccessTokenRequest
descriptionRequest message for GenerateAccessToken.
idGenerateAccessTokenRequest
properties
expireTime
descriptionDesired expiration time of the access token. This value must be at most 24 hours in the future. If a value is not specified, the token's expiration time will be set to a default value of 1 hour in the future.
formatgoogle-datetime
typestring
port
descriptionOptional. Port for which the access token should be generated. If specified, the generated access token grants access only to the specified port of the workstation. If specified, values must be within the range [1 - 65535]. If not specified, the generated access token grants access to all ports of the workstation.
formatint32
typeinteger
ttl
descriptionDesired lifetime duration of the access token. This value must be at most 24 hours. If a value is not specified, the token's lifetime will be set to a default value of 1 hour.
formatgoogle-duration
typestring
typeobject
GenerateAccessTokenResponse
descriptionResponse message for GenerateAccessToken.
idGenerateAccessTokenResponse
properties
accessToken
descriptionThe generated bearer access token. To use this token, include it in an Authorization header of an HTTP request sent to the associated workstation's hostname—for example, `Authorization: Bearer `.
typestring
expireTime
descriptionTime at which the generated token will expire.
formatgoogle-datetime
typestring
typeobject
GoogleProtobufEmpty
descriptionA 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); }
idGoogleProtobufEmpty
properties
typeobject
Host
descriptionRuntime host for a workstation.
idHost
properties
gceInstance
$refGceInstance
descriptionSpecifies a Compute Engine instance as the host.
typeobject
HttpOptions
descriptionHTTP options for the running workstations.
idHttpOptions
properties
allowedUnauthenticatedCorsPreflightRequests
descriptionOptional. By default, the workstations service makes sure that all requests to the workstation are authenticated. CORS preflight requests do not include cookies or custom headers, and so are considered unauthenticated and blocked by the workstations service. Enabling this option allows these unauthenticated CORS preflight requests through to the workstation, where it becomes the responsibility of the destination server in the workstation to validate the request.
typeboolean
disableLocalhostReplacement
descriptionOptional. By default, the workstations service replaces references to localhost, 127.0.0.1, and 0.0.0.0 with the workstation's hostname in http responses from the workstation so that applications under development run properly on the workstation. This may intefere with some applications, and so this option allows that behavior to be disabled.
typeboolean
typeobject
ListOperationsResponse
descriptionThe response message for Operations.ListOperations.
idListOperationsResponse
properties
nextPageToken
descriptionThe standard List next-page token.
typestring
operations
descriptionA list of operations that matches the specified filter in the request.
items
$refOperation
typearray
typeobject
ListUsableWorkstationConfigsResponse
descriptionResponse message for ListUsableWorkstationConfigs.
idListUsableWorkstationConfigsResponse
properties
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionUnreachable resources.
items
typestring
typearray
workstationConfigs
descriptionThe requested configs.
items
$refWorkstationConfig
typearray
typeobject
ListUsableWorkstationsResponse
descriptionResponse message for ListUsableWorkstations.
idListUsableWorkstationsResponse
properties
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionUnreachable resources.
items
typestring
typearray
workstations
descriptionThe requested workstations.
items
$refWorkstation
typearray
typeobject
ListWorkstationClustersResponse
descriptionResponse message for ListWorkstationClusters.
idListWorkstationClustersResponse
properties
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionUnreachable resources.
items
typestring
typearray
workstationClusters
descriptionThe requested workstation clusters.
items
$refWorkstationCluster
typearray
typeobject
ListWorkstationConfigsResponse
descriptionResponse message for ListWorkstationConfigs.
idListWorkstationConfigsResponse
properties
nextPageToken
descriptionToken to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionUnreachable resources.
items
typestring
typearray
workstationConfigs
descriptionThe requested configs.
items
$refWorkstationConfig
typearray
typeobject
ListWorkstationsResponse
descriptionResponse message for ListWorkstations.
idListWorkstationsResponse
properties
nextPageToken
descriptionOptional. Token to retrieve the next page of results, or empty if there are no more results in the list.
typestring
unreachable
descriptionOptional. Unreachable resources.
items
typestring
typearray
workstations
descriptionThe requested workstations.
items
$refWorkstation
typearray
typeobject
Operation
descriptionThis resource represents a long-running operation that is the result of a network API call.
idOperation
properties
done
descriptionIf the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
typeboolean
error
$refStatus
descriptionThe error result of the operation in case of failure or cancellation.
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
typeobject
name
descriptionThe server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
typestring
response
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionThe normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
typeobject
typeobject
OperationMetadata
descriptionMetadata for long-running operations.
idOperationMetadata
properties
apiVersion
descriptionOutput only. API version used to start the operation.
readOnlyTrue
typestring
createTime
descriptionOutput only. Time that the operation was created.
formatgoogle-datetime
readOnlyTrue
typestring
endTime
descriptionOutput only. Time that the operation finished running.
formatgoogle-datetime
readOnlyTrue
typestring
requestedCancellation
descriptionOutput only. Identifies whether the user has requested cancellation of the operation.
readOnlyTrue
typeboolean
statusMessage
descriptionOutput only. Human-readable status of the operation, if any.
readOnlyTrue
typestring
target
descriptionOutput only. Server-defined resource path for the target of the operation.
readOnlyTrue
typestring
verb
descriptionOutput only. Name of the verb executed by the operation.
readOnlyTrue
typestring
typeobject
PersistentDirectory
descriptionA directory to persist across workstation sessions. Updates to this field will not update existing workstations and will only take effect on new workstations.
idPersistentDirectory
properties
gcePd
$refGceRegionalPersistentDisk
descriptionA PersistentDirectory backed by a Compute Engine persistent disk.
mountPath
descriptionOptional. Location of this directory in the running workstation.
typestring
typeobject
Policy
descriptionAn 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/).
idPolicy
properties
auditConfigs
descriptionSpecifies cloud audit logging configuration for this policy.
items
$refAuditConfig
typearray
bindings
descriptionAssociates 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`.
items
$refBinding
typearray
etag
description`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.
formatbyte
typestring
version
descriptionSpecifies 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).
formatint32
typeinteger
typeobject
PortRange
descriptionA PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.
idPortRange
properties
first
descriptionRequired. Starting port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535.
formatint32
typeinteger
last
descriptionRequired. Ending port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535.
formatint32
typeinteger
typeobject
PrivateClusterConfig
descriptionConfiguration options for private workstation clusters.
idPrivateClusterConfig
properties
allowedProjects
descriptionOptional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.
items
typestring
typearray
clusterHostname
descriptionOutput only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.
readOnlyTrue
typestring
enablePrivateEndpoint
descriptionImmutable. Whether Workstations endpoint is private.
typeboolean
serviceAttachmentUri
descriptionOutput only. Service attachment URI for the workstation cluster. The service attachment is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).
readOnlyTrue
typestring
typeobject
ReadinessCheck
descriptionA readiness check to be performed on a workstation.
idReadinessCheck
properties
path
descriptionOptional. Path to which the request should be sent.
typestring
port
descriptionOptional. Port to which the request should be sent.
formatint32
typeinteger
typeobject
RuntimeHost
descriptionRuntime host for the workstation.
idRuntimeHost
properties
gceInstanceHost
$refGceInstanceHost
descriptionSpecifies a Compute Engine instance as the host.
typeobject
SetIamPolicyRequest
descriptionRequest message for `SetIamPolicy` method.
idSetIamPolicyRequest
properties
policy
$refPolicy
descriptionREQUIRED: 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 a valid policy but certain Google Cloud services (such as Projects) might reject them.
updateMask
descriptionOPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
formatgoogle-fieldmask
typestring
typeobject
StartWorkstationRequest
descriptionRequest message for StartWorkstation.
idStartWorkstationRequest
properties
boostConfig
descriptionOptional. If set, the workstation starts using the boost configuration with the specified ID.
typestring
etag
descriptionOptional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
typeboolean
typeobject
Status
descriptionThe `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).
idStatus
properties
code
descriptionThe status code, which should be an enum value of google.rpc.Code.
formatint32
typeinteger
details
descriptionA list of messages that carry the error details. There is a common set of message types for APIs to use.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
message
descriptionA 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.
typestring
typeobject
StopWorkstationRequest
descriptionRequest message for StopWorkstation.
idStopWorkstationRequest
properties
etag
descriptionOptional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
typestring
validateOnly
descriptionOptional. If set, validate the request and preview the review, but do not actually apply it.
typeboolean
typeobject
TestIamPermissionsRequest
descriptionRequest message for `TestIamPermissions` method.
idTestIamPermissionsRequest
properties
permissions
descriptionThe set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
items
typestring
typearray
typeobject
TestIamPermissionsResponse
descriptionResponse message for `TestIamPermissions` method.
idTestIamPermissionsResponse
properties
permissions
descriptionA subset of `TestPermissionsRequest.permissions` that the caller is allowed.
items
typestring
typearray
typeobject
Workstation
descriptionA single instance of a developer workstation with its own persistent storage.
idWorkstation
properties
annotations
additionalProperties
typestring
descriptionOptional. Client-specified annotations.
typeobject
boostConfigs
descriptionOutput only. List of available boost configuration IDs that this workstation can be boosted up to.
items
$refWorkstationBoostConfig
readOnlyTrue
typearray
conditions
descriptionOutput only. Status conditions describing the workstation's current state.
items
$refStatus
readOnlyTrue
typearray
createTime
descriptionOutput only. Time when this workstation was created.
formatgoogle-datetime
readOnlyTrue
typestring
degraded
descriptionOutput only. Whether this workstation is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
readOnlyTrue
typeboolean
deleteTime
descriptionOutput only. Time when this workstation was soft-deleted.
formatgoogle-datetime
readOnlyTrue
typestring
displayName
descriptionOptional. Human-readable name for this workstation.
typestring
env
additionalProperties
typestring
descriptionOptional. Environment variables passed to the workstation container's entrypoint.
typeobject
etag
descriptionOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
typestring
host
descriptionOutput only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`.
readOnlyTrue
typestring
kmsKey
descriptionOutput only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
readOnlyTrue
typestring
labels
additionalProperties
typestring
descriptionOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.
typeobject
name
descriptionIdentifier. Full name of this workstation.
typestring
reconciling
descriptionOutput only. Indicates whether this workstation is currently being updated to match its intended state.
readOnlyTrue
typeboolean
runtimeHost
$refRuntimeHost
descriptionOptional. Output only. Runtime host for the workstation when in STATE_RUNNING.
readOnlyTrue
satisfiesPzi
descriptionOutput only. Reserved for future use.
readOnlyTrue
typeboolean
satisfiesPzs
descriptionOutput only. Reserved for future use.
readOnlyTrue
typeboolean
sourceWorkstation
descriptionOptional. The source workstation from which this workstation's persistent directories were cloned on creation.
typestring
startTime
descriptionOutput only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.
formatgoogle-datetime
readOnlyTrue
typestring
state
descriptionOutput only. Current state of the workstation.
enum
  • STATE_UNSPECIFIED
  • STATE_STARTING
  • STATE_RUNNING
  • STATE_STOPPING
  • STATE_STOPPED
enumDescriptions
  • Do not use.
  • The workstation is not yet ready to accept requests from users but will be soon.
  • The workstation is ready to accept requests from users.
  • The workstation is being stopped.
  • The workstation is stopped and will not be able to receive requests until it is started.
readOnlyTrue
typestring
uid
descriptionOutput only. A system-assigned unique identifier for this workstation.
readOnlyTrue
typestring
updateTime
descriptionOutput only. Time when this workstation was most recently updated.
formatgoogle-datetime
readOnlyTrue
typestring
typeobject
WorkstationBoostConfig
descriptionBoost configuration for this workstation. This object is populated from the parent workstation configuration.
idWorkstationBoostConfig
properties
id
descriptionOutput only. Boost configuration ID.
readOnlyTrue
typestring
typeobject
WorkstationCluster
descriptionA workstation cluster resource in the Cloud Workstations API. Defines a group of workstations in a particular region and the VPC network they're attached to.
idWorkstationCluster
properties
annotations
additionalProperties
typestring
descriptionOptional. Client-specified annotations.
typeobject
conditions
descriptionOutput only. Status conditions describing the workstation cluster's current state.
items
$refStatus
readOnlyTrue
typearray
controlPlaneIp
descriptionOutput only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.
readOnlyTrue
typestring
createTime
descriptionOutput only. Time when this workstation cluster was created.
formatgoogle-datetime
readOnlyTrue
typestring
degraded
descriptionOutput only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
readOnlyTrue
typeboolean
deleteTime
descriptionOutput only. Time when this workstation cluster was soft-deleted.
formatgoogle-datetime
readOnlyTrue
typestring
displayName
descriptionOptional. Human-readable name for this workstation cluster.
typestring
domainConfig
$refDomainConfig
descriptionOptional. Configuration options for a custom domain.
etag
descriptionOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
typestring
labels
additionalProperties
typestring
descriptionOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
typeobject
name
descriptionIdentifier. Full name of this workstation cluster.
typestring
network
descriptionImmutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
typestring
privateClusterConfig
$refPrivateClusterConfig
descriptionOptional. Configuration for private workstation cluster.
reconciling
descriptionOutput only. Indicates whether this workstation cluster is currently being updated to match its intended state.
readOnlyTrue
typeboolean
satisfiesPzi
descriptionOutput only. Reserved for future use.
readOnlyTrue
typeboolean
satisfiesPzs
descriptionOutput only. Reserved for future use.
readOnlyTrue
typeboolean
subnetwork
descriptionImmutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.
typestring
tags
additionalProperties
typestring
descriptionOptional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
typeobject
uid
descriptionOutput only. A system-assigned unique identifier for this workstation cluster.
readOnlyTrue
typestring
updateTime
descriptionOutput only. Time when this workstation cluster was most recently updated.
formatgoogle-datetime
readOnlyTrue
typestring
typeobject
WorkstationConfig
descriptionA workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers.
idWorkstationConfig
properties
allowedPorts
descriptionOptional. A list of PortRanges specifying single ports or ranges of ports that are externally accessible in the workstation. Allowed ports must be one of 22, 80, or within range 1024-65535. If not specified defaults to ports 22, 80, and ports 1024-65535.
items
$refPortRange
typearray
annotations
additionalProperties
typestring
descriptionOptional. Client-specified annotations.
typeobject
conditions
descriptionOutput only. Status conditions describing the current resource state.
items
$refStatus
readOnlyTrue
typearray
container
$refContainer
descriptionOptional. Container that runs upon startup for each workstation using this workstation configuration.
createTime
descriptionOutput only. Time when this workstation configuration was created.
formatgoogle-datetime
readOnlyTrue
typestring
degraded
descriptionOutput only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the conditions field.
readOnlyTrue
typeboolean
deleteTime
descriptionOutput only. Time when this workstation configuration was soft-deleted.
formatgoogle-datetime
readOnlyTrue
typestring
disableTcpConnections
descriptionOptional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS.
typeboolean
displayName
descriptionOptional. Human-readable name for this workstation configuration.
typestring
enableAuditAgent
descriptionOptional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](https://cloud.google.com/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd"
typeboolean
encryptionKey
$refCustomerEncryptionKey
descriptionImmutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created.
ephemeralDirectories
descriptionOptional. Ephemeral directories which won't persist across workstation sessions.
items
$refEphemeralDirectory
typearray
etag
descriptionOptional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
typestring
grantWorkstationAdminRoleOnCreate
descriptionOptional. Grant creator of a workstation `roles/workstations.policyAdmin` role along with `roles/workstations.user` role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false.
typeboolean
host
$refHost
descriptionOptional. Runtime host for the workstation.
httpOptions
$refHttpOptions
descriptionOptional. HTTP options that customize the behavior of the workstation service's HTTP proxy.
idleTimeout
descriptionOptional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes).
formatgoogle-duration
typestring
labels
additionalProperties
typestring
descriptionOptional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
typeobject
maxUsableWorkstations
descriptionOptional. Maximum number of workstations under this configuration a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified, defaults to `0`, which indicates unlimited.
formatint32
typeinteger
name
descriptionIdentifier. Full name of this workstation configuration.
typestring
persistentDirectories
descriptionOptional. Directories to persist across workstation sessions.
items
$refPersistentDirectory
typearray
readinessChecks
descriptionOptional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
items
$refReadinessCheck
typearray
reconciling
descriptionOutput only. Indicates whether this workstation configuration is currently being updated to match its intended state.
readOnlyTrue
typeboolean
replicaZones
descriptionOptional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created.
items
typestring
typearray
runningTimeout
descriptionOptional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.
formatgoogle-duration
typestring
satisfiesPzi
descriptionOutput only. Reserved for future use.
readOnlyTrue
typeboolean
satisfiesPzs
descriptionOutput only. Reserved for future use.
readOnlyTrue
typeboolean
uid
descriptionOutput only. A system-assigned unique identifier for this workstation configuration.
readOnlyTrue
typestring
updateTime
descriptionOutput only. Time when this workstation configuration was most recently updated.
formatgoogle-datetime
readOnlyTrue
typestring
typeobject
servicePath
titleCloud Workstations API (staging)
versionv1beta
version_moduleTrue
old_value
error
code403
details
  • @typetype.googleapis.com/google.rpc.Help
    links
    descriptionurl
    Google developers console API activationhttps://console.developers.google.com/apis/api/staging-workstations.sandbox.googleapis.com/overview?project=292824132082
  • @typetype.googleapis.com/google.rpc.ErrorInfo
    domaingoogleapis.com
    metadata
    consumerprojects/292824132082
    servicestaging-workstations.sandbox.googleapis.com
    reasonSERVICE_DISABLED
messageCloud Workstations API (staging) has not been used in project 292824132082 before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/staging-workstations.sandbox.googleapis.com/overview?project=292824132082 then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.
statusPERMISSION_DENIED
sandbox/staging-wrenchworks-
dictionary_item_added
  • root['schemas']['PartialResultSet']['properties']['last']
values_changed
root['revision']
new_value20250218
old_value20250217
sandbox/staging-wrenchworks-v1
dictionary_item_added
  • root['schemas']['PartialResultSet']['properties']['last']
values_changed
root['revision']
new_value20250218
old_value20250217
sandbox/test-accessapproval-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/test-accessapproval-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/test-bigqueryconnection-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/test-bigqueryconnection-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/test-bigqueryconnection-v1beta1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/test-bigquerydatatransfer-
dictionary_item_removed
  • root['resources']['projects']['methods']['isEnabled']
  • root['resources']['projects']['methods']['setEnabled']
  • root['resources']['projects']['resources']['locations']['methods']['enableDataTransferService']
  • root['resources']['projects']['resources']['locations']['methods']['isDataTransferServiceEnabled']
  • root['resources']['projects']['resources']['locations']['methods']['setEnabled']
  • root['resources']['projects']['resources']['locations']['methods']['list']['parameters']['includeUnrevealedLocations']
  • root['resources']['projects']['resources']['locations']['resources']['dataSourceDefinitions']
  • root['resources']['projects']['resources']['locations']['resources']['dtsTenantProject']
  • root['resources']['projects']['resources']['locations']['resources']['dtsTenantProjects']
  • root['resources']['projects']['resources']['locations']['resources']['experiments']
  • root['resources']['projects']['resources']['locations']['resources']['dataSources']['resources']
  • root['resources']['projects']['resources']['locations']['resources']['dataSources']['methods']['browse']
  • root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['methods']['log3pTosAccepted']
  • root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['methods']['partition']
  • root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['methods']['stream']
  • root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['methods']['create']['parameters']['transferConfigId']
  • root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['resources']['-']
  • root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['resources']['runs']['resources']['subtasks']
  • root['resources']['projects']['resources']['transferConfigs']['methods']['create']['parameters']['transferConfigId']
  • root['resources']['projects']['resources']['transferConfigs']['resources']['runs']['methods']['cancel']
  • root['resources']['projects']['resources']['transferConfigs']['resources']['runs']['methods']['create']
values_changed
root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['resources']['runs']['methods']
new_value
delete
descriptionDeletes the specified transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
httpMethodDELETE
idbigquerydatatransfer.projects.locations.transferConfigs.runs.delete
parameterOrder
  • name
parameters
name
descriptionRequired. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionReturns information about the particular transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
httpMethodGET
idbigquerydatatransfer.projects.locations.transferConfigs.runs.get
parameterOrder
  • name
parameters
name
descriptionRequired. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refTransferRun
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
list
descriptionReturns information about running and completed transfer runs.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs
httpMethodGET
idbigquerydatatransfer.projects.locations.transferConfigs.runs.list
parameterOrder
  • parent
parameters
pageSize
descriptionPage size. The default page size is the maximum value of 1000 results.
formatint32
locationquery
typeinteger
pageToken
descriptionPagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
locationquery
typestring
parent
descriptionRequired. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
requiredTrue
typestring
runAttempt
descriptionIndicates how run attempts are to be pulled.
enum
  • RUN_ATTEMPT_UNSPECIFIED
  • LATEST
enumDescriptions
  • All runs should be returned.
  • Only latest run per day should be returned.
locationquery
typestring
states
descriptionWhen specified, only transfer runs with requested states are returned.
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
locationquery
repeatedTrue
typestring
pathv1/{+parent}/runs
response
$refListTransferRunsResponse
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
old_value
cancel
descriptionCancels a data transfer run. Marks run as cancelled. It is up to the data source to decide at which point the transfer run is cancelled. Only supported for batch data sources. Unlike delete, it retains the transfer run and just sets the transfer run state to CANCELLED, so that data source can stop ingesting data (if that is possible).
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:cancel
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.cancel
parameterOrder
  • name
parameters
name
descriptionRequired. The field will contain the name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`.
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:cancel
request
$refCancelTransferRunRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
create
descriptionCreates a single transfer run for this data transfer. Only supported for batch data sources.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.create
parameterOrder
  • parent
parameters
parent
descriptionTransfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or . `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/runs
request
$refTransferRun
response
$refTransferRun
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes the specified transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
httpMethodDELETE
idbigquerydatatransfer.projects.locations.transferConfigs.runs.delete
parameterOrder
  • name
parameters
name
descriptionRequired. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
finishRun
descriptionNotify the Data Transfer Service that the data source is done processing the run. No more status updates or requests to start/monitor jobs will be accepted. The run will be finalized by the Data Transfer Service when all monitored jobs are completed. Does not need to be called if the run is set to FAILED.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:finishRun
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.finishRun
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:finishRun
request
$refFinishRunRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionReturns information about the particular transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
httpMethodGET
idbigquerydatatransfer.projects.locations.transferConfigs.runs.get
parameterOrder
  • name
parameters
name
descriptionRequired. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refTransferRun
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
getInternal
descriptionReturns information about the specified transfer run. This API is for internal clients and will not be exposed to external customers. Caller needs to be internally allow-listed, or have `bigquery.datasources.update` permission to call this API.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:getInternal
httpMethodGET
idbigquerydatatransfer.projects.locations.transferConfigs.runs.getInternal
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the transfer run in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:getInternal
response
$refTransferRun
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
getRunSummary
descriptionRetrieves summary of jobs that were started by the given transfer run. Note that a stale read against the database is performed with 10 seconds staleness. It is important that this only summarizes the jobs that were created as of the database read timestamp. It is possible that the transfer run is not finalized and more jobs will be created. Can be used to let the data source wait for jobs to finish before continuing other work.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/runSummary
httpMethodGET
idbigquerydatatransfer.projects.locations.transferConfigs.runs.getRunSummary
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the transfer run in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}/runSummary
response
$refTransferRunSummary
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionReturns information about running and completed transfer runs.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs
httpMethodGET
idbigquerydatatransfer.projects.locations.transferConfigs.runs.list
parameterOrder
  • parent
parameters
pageSize
descriptionPage size. The default page size is the maximum value of 1000 results.
formatint32
locationquery
typeinteger
pageToken
descriptionPagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
locationquery
typestring
parent
descriptionRequired. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
requiredTrue
typestring
runAttempt
descriptionIndicates how run attempts are to be pulled.
enum
  • RUN_ATTEMPT_UNSPECIFIED
  • LATEST
enumDescriptions
  • All runs should be returned.
  • Only latest run per day should be returned.
locationquery
typestring
states
descriptionWhen specified, only transfer runs with requested states are returned.
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
locationquery
repeatedTrue
typestring
pathv1/{+parent}/runs
response
$refListTransferRunsResponse
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
logMessages
descriptionLog messages for a transfer run. If successful (at least 1 message), resets data_source.update_deadline_seconds timer.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:logMessages
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.logMessages
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:logMessages
request
$refLogTransferRunMessagesRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
monitorBigQueryJobs
descriptionNotify the Data Transfer Service that the following BigQuery jobs should be monitored. Monitored jobs will be automatically retried and produce log messages when starting and finishing a job. Used when a data source initiates multiple BigQuery jobs outside of StartBigQueryJobs. Can be called multiple times for the same transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:monitorBigQueryJobs
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.monitorBigQueryJobs
parameterOrder
  • name
parameters
name
descriptionName of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:monitorBigQueryJobs
request
$refMonitorBigQueryJobsRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
patch
descriptionUpdate a transfer run. If successful, resets data_source.update_deadline_seconds timer.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
httpMethodPATCH
idbigquerydatatransfer.projects.locations.transferConfigs.runs.patch
parameterOrder
  • name
parameters
name
descriptionIdentifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired list of fields to be updated in this request.
formatgoogle-fieldmask
locationquery
typestring
pathv1/{+name}
request
$refTransferRun
response
$refTransferRun
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
recordBillingMeasurement
descriptionRecord a billing measurement entry to a transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:recordBillingMeasurement
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.recordBillingMeasurement
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the transfer run to record billing measurement for. Format: `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:recordBillingMeasurement
request
$refRecordTransferRunBillingMeasurementRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
startBigQueryJobs
descriptionNotify the Data Transfer Service that data is ready for loading. The Data Transfer Service will start and monitor multiple BigQuery Load jobs for a transfer run. Monitored jobs will be automatically retried and produce log messages when starting and finishing a job. Can be called multiple times for the same transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:startBigQueryJobs
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.startBigQueryJobs
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:startBigQueryJobs
request
$refStartBigQueryJobsRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
root['revision']
new_value20250220
old_value20250218
root['schemas']
new_value
CheckValidCredsRequest
descriptionA request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.
idCheckValidCredsRequest
properties
typeobject
CheckValidCredsResponse
descriptionA response indicating whether the credentials exist and are valid.
idCheckValidCredsResponse
properties
hasValidCreds
descriptionIf set to `true`, the credentials exist and are valid.
typeboolean
typeobject
DataSource
descriptionDefines the properties and custom parameters for a data source.
idDataSource
properties
authorizationType
descriptionIndicates the type of authorization.
enum
  • AUTHORIZATION_TYPE_UNSPECIFIED
  • AUTHORIZATION_CODE
  • GOOGLE_PLUS_AUTHORIZATION_CODE
  • FIRST_PARTY_OAUTH
enumDescriptions
  • Type unspecified.
  • Use OAuth 2 authorization codes that can be exchanged for a refresh token on the backend.
  • Return an authorization code for a given Google+ page that can then be exchanged for a refresh token on the backend.
  • Use First Party OAuth.
typestring
clientId
descriptionData source client id which should be used to receive refresh token.
typestring
dataRefreshType
descriptionSpecifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.
enum
  • DATA_REFRESH_TYPE_UNSPECIFIED
  • SLIDING_WINDOW
  • CUSTOM_SLIDING_WINDOW
enumDescriptions
  • The data source won't support data auto refresh, which is default value.
  • The data source supports data auto refresh, and runs will be scheduled for the past few days. Does not allow custom values to be set for each transfer config.
  • The data source supports data auto refresh, and runs will be scheduled for the past few days. Allows custom values to be set for each transfer config.
typestring
dataSourceId
descriptionData source id.
typestring
defaultDataRefreshWindowDays
descriptionDefault data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
formatint32
typeinteger
defaultSchedule
descriptionDefault data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`.
typestring
description
descriptionUser friendly data source description string.
typestring
displayName
descriptionUser friendly data source name.
typestring
helpUrl
descriptionUrl for the help document for this data source.
typestring
manualRunsDisabled
descriptionDisables backfilling and manual run scheduling for the data source.
typeboolean
minimumScheduleInterval
descriptionThe minimum interval for scheduler to schedule runs.
formatgoogle-duration
typestring
name
descriptionOutput only. Data source resource name.
readOnlyTrue
typestring
parameters
descriptionData source parameters.
items
$refDataSourceParameter
typearray
scopes
descriptionApi auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
items
typestring
typearray
supportsCustomSchedule
descriptionSpecifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule.
typeboolean
supportsMultipleTransfers
deprecatedTrue
descriptionDeprecated. This field has no effect.
typeboolean
transferType
deprecatedTrue
descriptionDeprecated. This field has no effect.
enum
  • TRANSFER_TYPE_UNSPECIFIED
  • BATCH
  • STREAMING
enumDescriptions
  • Invalid or Unknown transfer type placeholder.
  • Batch data transfer.
  • Streaming data transfer. Streaming data source currently doesn't support multiple transfer configs per project.
typestring
updateDeadlineSeconds
descriptionThe number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
formatint32
typeinteger
typeobject
DataSourceParameter
descriptionA parameter used to define custom fields in a data source definition.
idDataSourceParameter
properties
allowedValues
descriptionAll possible values for the parameter.
items
typestring
typearray
deprecated
descriptionIf true, it should not be used in new transfers, and it should not be visible to users.
typeboolean
description
descriptionParameter description.
typestring
displayName
descriptionParameter display name in the user interface.
typestring
fields
descriptionDeprecated. This field has no effect.
items
$refDataSourceParameter
typearray
immutable
descriptionCannot be changed after initial creation.
typeboolean
maxValue
descriptionFor integer and double values specifies maximum allowed value.
formatdouble
typenumber
minValue
descriptionFor integer and double values specifies minimum allowed value.
formatdouble
typenumber
paramId
descriptionParameter identifier.
typestring
recurse
descriptionDeprecated. This field has no effect.
typeboolean
repeated
descriptionDeprecated. This field has no effect.
typeboolean
required
descriptionIs parameter required.
typeboolean
type
descriptionParameter type.
enum
  • TYPE_UNSPECIFIED
  • STRING
  • INTEGER
  • DOUBLE
  • BOOLEAN
  • RECORD
  • PLUS_PAGE
  • LIST
enumDescriptions
  • Type unspecified.
  • String parameter.
  • Integer parameter (64-bits). Will be serialized to json as string.
  • Double precision floating point parameter.
  • Boolean parameter.
  • Deprecated. This field has no effect.
  • Page ID for a Google+ Page.
  • List of strings parameter.
typestring
validationDescription
descriptionDescription of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
typestring
validationHelpUrl
descriptionURL to a help document to further explain the naming requirements.
typestring
validationRegex
descriptionRegular expression which can be used for parameter validation.
typestring
typeobject
EmailPreferences
descriptionRepresents preferences for sending email notifications for transfer run events.
idEmailPreferences
properties
enableFailureEmail
descriptionIf true, email notifications will be sent on transfer run failures.
typeboolean
typeobject
Empty
descriptionA 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); }
idEmpty
properties
typeobject
EncryptionConfiguration
descriptionRepresents the encryption configuration for a transfer.
idEncryptionConfiguration
properties
kmsKeyName
descriptionThe name of the KMS key used for encrypting BigQuery data.
typestring
typeobject
EnrollDataSourcesRequest
descriptionA request to enroll a set of data sources so they are visible in the BigQuery UI's `Transfer` tab.
idEnrollDataSourcesRequest
properties
dataSourceIds
descriptionData sources that are enrolled. It is required to provide at least one data source id.
items
typestring
typearray
typeobject
EventDrivenSchedule
descriptionOptions customizing EventDriven transfers schedule.
idEventDrivenSchedule
properties
pubsubSubscription
descriptionPub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project}/subscriptions/{subscription}
typestring
typeobject
ListDataSourcesResponse
descriptionReturns list of supported data sources and their metadata.
idListDataSourcesResponse
properties
dataSources
descriptionList of supported data sources and their transfer settings.
items
$refDataSource
typearray
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourcesRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
typeobject
ListLocationsResponse
descriptionThe response message for Locations.ListLocations.
idListLocationsResponse
properties
locations
descriptionA list of locations that matches the specified filter in the request.
items
$refLocation
typearray
nextPageToken
descriptionThe standard List next-page token.
typestring
typeobject
ListTransferConfigsResponse
descriptionThe returned list of pipelines in the project.
idListTransferConfigsResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
transferConfigs
descriptionOutput only. The stored pipeline transfer configurations.
items
$refTransferConfig
readOnlyTrue
typearray
typeobject
ListTransferLogsResponse
descriptionThe returned list transfer run messages.
idListTransferLogsResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `GetTransferRunLogRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
transferMessages
descriptionOutput only. The stored pipeline transfer messages.
items
$refTransferMessage
readOnlyTrue
typearray
typeobject
ListTransferRunsResponse
descriptionThe returned list of pipelines in the project.
idListTransferRunsResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
transferRuns
descriptionOutput only. The stored pipeline transfer runs.
items
$refTransferRun
readOnlyTrue
typearray
typeobject
Location
descriptionA resource that represents a Google Cloud location.
idLocation
properties
displayName
descriptionThe friendly name for this location, typically a nearby city name. For example, "Tokyo".
typestring
labels
additionalProperties
typestring
descriptionCross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
typeobject
locationId
descriptionThe canonical id for this location. For example: `"us-east1"`.
typestring
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata. For example the available capacity at the given location.
typeobject
name
descriptionResource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
typestring
typeobject
ManualSchedule
descriptionOptions customizing manual transfers schedule.
idManualSchedule
properties
typeobject
ScheduleOptions
descriptionOptions customizing the data transfer schedule.
idScheduleOptions
properties
disableAutoScheduling
descriptionIf true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
typeboolean
endTime
descriptionDefines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.
formatgoogle-datetime
typestring
startTime
descriptionSpecifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.
formatgoogle-datetime
typestring
typeobject
ScheduleOptionsV2
descriptionV2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
idScheduleOptionsV2
properties
eventDrivenSchedule
$refEventDrivenSchedule
descriptionEvent driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.
manualSchedule
$refManualSchedule
descriptionManual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.
timeBasedSchedule
$refTimeBasedSchedule
descriptionTime based transfer schedule options. This is the default schedule option.
typeobject
ScheduleTransferRunsRequest
descriptionA request to schedule transfer runs for a time range.
idScheduleTransferRunsRequest
properties
endTime
descriptionRequired. End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`.
formatgoogle-datetime
typestring
startTime
descriptionRequired. Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`.
formatgoogle-datetime
typestring
typeobject
ScheduleTransferRunsResponse
descriptionA response to schedule transfer runs for a time range.
idScheduleTransferRunsResponse
properties
runs
descriptionThe transfer runs that were scheduled.
items
$refTransferRun
typearray
typeobject
StartManualTransferRunsRequest
descriptionA request to start manual transfer runs.
idStartManualTransferRunsRequest
properties
requestedRunTime
descriptionA run_time timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_run_time must be a past time and cannot include future time values.
formatgoogle-datetime
typestring
requestedTimeRange
$refTimeRange
descriptionA time_range start and end timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_time_range must be a past time and cannot include future time values.
typeobject
StartManualTransferRunsResponse
descriptionA response to start manual transfer runs.
idStartManualTransferRunsResponse
properties
runs
descriptionThe transfer runs that were created.
items
$refTransferRun
typearray
typeobject
Status
descriptionThe `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).
idStatus
properties
code
descriptionThe status code, which should be an enum value of google.rpc.Code.
formatint32
typeinteger
details
descriptionA list of messages that carry the error details. There is a common set of message types for APIs to use.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
message
descriptionA 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.
typestring
typeobject
TimeBasedSchedule
descriptionOptions customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.
idTimeBasedSchedule
properties
endTime
descriptionDefines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment.
formatgoogle-datetime
typestring
schedule
descriptionData transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
typestring
startTime
descriptionSpecifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment.
formatgoogle-datetime
typestring
typeobject
TimeRange
descriptionA specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).
idTimeRange
properties
endTime
descriptionEnd time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
formatgoogle-datetime
typestring
startTime
descriptionStart time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
formatgoogle-datetime
typestring
typeobject
TransferConfig
descriptionRepresents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
idTransferConfig
properties
dataRefreshWindowDays
descriptionThe number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
formatint32
typeinteger
dataSourceId
descriptionData source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
typestring
datasetRegion
descriptionOutput only. Region in which BigQuery dataset is located.
readOnlyTrue
typestring
destinationDatasetId
descriptionThe BigQuery target dataset id.
typestring
disabled
descriptionIs this config disabled. When set to true, no runs will be scheduled for this transfer config.
typeboolean
displayName
descriptionUser specified display name for the data transfer.
typestring
emailPreferences
$refEmailPreferences
descriptionEmail notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
encryptionConfiguration
$refEncryptionConfiguration
descriptionThe encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
error
$refStatus
descriptionOutput only. Error code with detailed information about reason of the latest config failure.
readOnlyTrue
name
descriptionIdentifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
typestring
nextRunTime
descriptionOutput only. Next time when data transfer will run.
formatgoogle-datetime
readOnlyTrue
typestring
notificationPubsubTopic
descriptionPub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
typestring
ownerInfo
$refUserInfo
descriptionOutput only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
readOnlyTrue
params
additionalProperties
descriptionProperties of the object.
typeany
descriptionParameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
typeobject
schedule
descriptionData transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
typestring
scheduleOptions
$refScheduleOptions
descriptionOptions customizing the data transfer schedule.
scheduleOptionsV2
$refScheduleOptionsV2
descriptionOptions customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
state
descriptionOutput only. State of the most recently updated transfer run.
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
readOnlyTrue
typestring
updateTime
descriptionOutput only. Data transfer modification time. Ignored by server on input.
formatgoogle-datetime
readOnlyTrue
typestring
userId
descriptionDeprecated. Unique ID of the user on whose behalf transfer is done.
formatint64
typestring
typeobject
TransferMessage
descriptionRepresents a user facing message for a particular data transfer run.
idTransferMessage
properties
messageText
descriptionMessage text.
typestring
messageTime
descriptionTime when message was logged.
formatgoogle-datetime
typestring
severity
descriptionMessage severity.
enum
  • MESSAGE_SEVERITY_UNSPECIFIED
  • INFO
  • WARNING
  • ERROR
enumDescriptions
  • No severity specified.
  • Informational message.
  • Warning message.
  • Error message.
typestring
typeobject
TransferRun
descriptionRepresents a data transfer run.
idTransferRun
properties
dataSourceId
descriptionOutput only. Data source id.
readOnlyTrue
typestring
destinationDatasetId
descriptionOutput only. The BigQuery target dataset id.
readOnlyTrue
typestring
emailPreferences
$refEmailPreferences
descriptionOutput only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
readOnlyTrue
endTime
descriptionOutput only. Time when transfer run ended. Parameter ignored by server for input requests.
formatgoogle-datetime
readOnlyTrue
typestring
errorStatus
$refStatus
descriptionStatus of the transfer run.
name
descriptionIdentifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
typestring
notificationPubsubTopic
descriptionOutput only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
readOnlyTrue
typestring
params
additionalProperties
descriptionProperties of the object.
typeany
descriptionOutput only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
readOnlyTrue
typeobject
runTime
descriptionFor batch transfer runs, specifies the date and time of the data should be ingested.
formatgoogle-datetime
typestring
schedule
descriptionOutput only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this.
readOnlyTrue
typestring
scheduleTime
descriptionMinimum time after which a transfer run can be started.
formatgoogle-datetime
typestring
startTime
descriptionOutput only. Time when transfer run was started. Parameter ignored by server for input requests.
formatgoogle-datetime
readOnlyTrue
typestring
state
descriptionData transfer run state. Ignored for input requests.
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
typestring
updateTime
descriptionOutput only. Last time the data transfer run state was updated.
formatgoogle-datetime
readOnlyTrue
typestring
userId
descriptionDeprecated. Unique ID of the user on whose behalf transfer is done.
formatint64
typestring
typeobject
UnenrollDataSourcesRequest
descriptionA request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's `Transfer` tab.
idUnenrollDataSourcesRequest
properties
dataSourceIds
descriptionData sources that are unenrolled. It is required to provide at least one data source id.
items
typestring
typearray
typeobject
UserInfo
descriptionInformation about a user.
idUserInfo
properties
email
descriptionE-mail address of the user.
typestring
typeobject
old_value
Asset
descriptionMessage for an asset in the browsing response.
idAsset
properties
asset
descriptionString that represents an asset. The client can use this string to continue to browse the data source if this asset can be browsed.
typestring
hasChild
descriptionIndicate if the asset can have child. The client can continue to browse using this asset.
typeboolean
typeobject
AvroOptions
descriptionAVRO specific options
idAvroOptions
properties
enableLogicalTypes
descriptionIf set to true will enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).
typeboolean
typeobject
BatchCreateTransferRunsRequest
descriptionRepresents request of BatchCreateTransferRuns method
idBatchCreateTransferRunsRequest
properties
transferRuns
descriptionList of TransferRuns to be scheduled. Runs can be from different data sources. All runs are committed as a single transaction, so this operation is atomic.
items
$refTransferRun
typearray
typeobject
BatchCreateTransferSubtasksRequest
descriptionRepresents request of BatchCreateTransferSubtasks method
idBatchCreateTransferSubtasksRequest
properties
dataVersion
descriptionData version of related subtasks.
typestring
hasMore
descriptionIf set to true, subsequent call can be made to append subtasks. If set to false(default), subsequent call will result in exception.
typeboolean
subtasks
descriptionList of subtasks (for one transfer run) to be scheduled. All subtasks are committed as a single transaction, so this operation is atomic. Name of the subtasks will be re-generated by backend, so the names from this fields will be ignored.
items
$refTransferSubtask
typearray
typeobject
BatchCreateTransferSubtasksResponse
descriptionRepresents response of BatchCreateTransferSubtasks method
idBatchCreateTransferSubtasksResponse
properties
subtasks
descriptionList of subtasks (for one transfer run) to be scheduled.
items
$refTransferSubtask
typearray
typeobject
BigQueryJobMonitoringInfo
descriptionContains necessary information to monitor a BigQuery job.
idBigQueryJobMonitoringInfo
properties
dataVersion
descriptionData version associated with the data the job is loading, if applicable. Used to ensure multiple jobs are not writing to the same table at the same time.
typestring
destinationTableId
descriptionDestination table of the job.
typestring
jobId
descriptionId of the BigQuery job to monitor.
typestring
typeobject
BrowseConfig
descriptionConfig for browsing assets in DTS 3P datasources.
idBrowseConfig
properties
optionalParams
descriptionOptional parameters for browsing assets - these are sent to the browse asset request if the user has entered something.
items
typestring
typearray
requiredParams
descriptionRequired parameters for browsing assets.
items
typestring
typearray
typeobject
BrowseDataSourceConfig
descriptionThis message contains all required parameters to browse a data source
idBrowseDataSourceConfig
properties
asset
descriptionParent asset for the browsing. If none is provided, start from root level.
typestring
params
additionalProperties
descriptionProperties of the object.
typeany
descriptionParams needed to access the data source.
typeobject
typeobject
BrowseDataSourceResponse
descriptionResponse of browsing a data source.
idBrowseDataSourceResponse
properties
assets
descriptionThe assets under the requested asset id
items
$refAsset
typearray
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page browsing results, this token can be used as the `BrowseDataSourceRequest.page_token` to request the next page of browsing results.
readOnlyTrue
typestring
typeobject
CancelTransferRunRequest
descriptionA request to cancel a data transfer run. Unlike delete, this method marks the transfer run state as `CANCELLED`. The transfer run itself and its logs are retained.
idCancelTransferRunRequest
properties
typeobject
CapabilityConfig
descriptionCapability config datasource specific features.
idCapabilityConfig
properties
browseConfig
$refBrowseConfig
descriptionEach config is optional and only included if the datasource is using that capability. Config for browsing assets in DTS 3P datasources
typeobject
CheckValidCredsRequest
descriptionA request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.
idCheckValidCredsRequest
properties
typeobject
CheckValidCredsResponse
descriptionA response indicating whether the credentials exist and are valid.
idCheckValidCredsResponse
properties
hasValidCreds
descriptionIf set to `true`, the credentials exist and are valid.
typeboolean
typeobject
Clustering
descriptionConfigures table clustering.
idClustering
properties
fields
descriptionOne or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. The ordering of the clustering fields should be prioritized from most to least important for filtering purposes. For additional information, see [Introduction to clustered tables](https://cloud.google.com/bigquery/docs/clustered-tables#limitations).
items
typestring
typearray
typeobject
CopyJobInfo
descriptionInformation to start a BigQuery copy job.
idCopyJobInfo
properties
copyCrossRegion
descriptionDescribe whether the copy operation is cross-region. Should only be set if copying table cross region.
typeboolean
dataVersion
descriptionData version associated with the data for this job. Used for deduplicating and ordering jobs.
typestring
destinationExpirationTime
descriptionThe time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
formatgoogle-datetime
typestring
destinationTableDescription
descriptionThe description of a destination table. This can be several sentences or paragraphs describing the table contents in detail.
typestring
destinationTableId
descriptionDestination table id. The full table reference is derived from the destination dataset defined in the transfer config and transfer run.
typestring
destinationTableKmsKey
descriptionOptional cloud KMS encryption key. When not specified default encryption is used.
typestring
jobProjectId
descriptionIf specified, jobs are billed to this project_id, rather than project_id of the TransferRun.
typestring
operationType
descriptionSupported operation types in table copy job.
enum
  • OPERATION_TYPE_UNSPECIFIED
  • COPY
  • SNAPSHOT
  • RESTORE
enumDescriptions
  • Unspecified operation type.
  • The source and destination table have the same table type.
  • The source table type is TABLE and the destination table type is SNAPSHOT.
  • The source table type is SNAPSHOT and the destination table type is TABLE.
typestring
requestedJobId
descriptionAdded for parity with ImportedDataInfo, so this field can be referenced in a shared template code.
typestring
sourceTableRef
descriptionSource table references.
items
$refTableReference
typearray
writeDisposition
descriptionSpecifies the action if the destination table already exists.
enum
  • WRITE_DISPOSITION_UNSPECIFIED
  • WRITE_TRUNCATE
  • WRITE_APPEND
  • WRITE_EMPTY
enumDescriptions
  • The default writeDispostion
  • overwrites the table data.
  • the data is appended to the table. Note duplication might happen if this mode is used.
  • This job should only be writing to empty tables.
typestring
typeobject
Credentials
descriptionCredentials for User associated with a specific data source.
idCredentials
properties
authToken
descriptionAuth token which can be used to perform requests on behalf of the user.
typestring
name
descriptionName of this credentials object in the form projects/-/locations/{location_id}/dataSources/{data_source_id}/credentials/{user_id}
typestring
typeobject
CsvOptions
descriptionCSV specific options.
idCsvOptions
properties
allowJaggedRows
descriptionAccept rows that are missing trailing optional columns.
typeboolean
allowQuotedNewlines
descriptionWhether CSV files are allowed to have quoted newlines. If quoted newlines are allowed, we can't split CSV files.
typeboolean
fieldDelimiter
descriptionThe delimiter. We currently restrict this to U+0001 to U+00FF and apply additional constraints during validation.
typestring
preserveAsciiControlCharacters
descriptionPreserve embedded Ascii Control characters.
typeboolean
quoteChar
descriptionThe quote character. We currently restrict this to U+0000 to U+00FF and apply additional constraints during validation. Set to '\0' to indicate no quote is used.
typestring
skipLeadingRows
descriptionNumber of leading rows to skip.
formatint64
typestring
typeobject
CustomScheduleGranularity
descriptionThe supported granularity of custom scheduling. Only applies if the data source supports custom scheduling.
idCustomScheduleGranularity
properties
daily
descriptionSupports daily based custom scheduling.
typeboolean
typeobject
DataSource
descriptionDefines the properties and custom parameters for a data source.
idDataSource
properties
authorizationType
descriptionIndicates the type of authorization.
enum
  • AUTHORIZATION_TYPE_UNSPECIFIED
  • AUTHORIZATION_CODE
  • GOOGLE_PLUS_AUTHORIZATION_CODE
  • FIRST_PARTY_OAUTH
enumDescriptions
  • Type unspecified.
  • Use OAuth 2 authorization codes that can be exchanged for a refresh token on the backend.
  • Return an authorization code for a given Google+ page that can then be exchanged for a refresh token on the backend.
  • Use First Party OAuth.
typestring
capabilities
descriptionCapabilities of a data source
items
enum
  • CAPABILITY_UNSPECIFIED
  • BROWSE
  • EVENT_DRIVEN_TRANSFER
enumDescriptions
  • No capabilities specified.
  • The data source supports browsing to return assets inside the given data source
  • The data source supports event driven transfer
typestring
typearray
capabilityConfig
$refCapabilityConfig
descriptionCapability config datasource specific features.
clientId
descriptionData source client id which should be used to receive refresh token.
typestring
customScheduleGranularity
$refCustomScheduleGranularity
descriptionThe supported granularity for custom schedule.
dataRefreshType
descriptionSpecifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.
enum
  • DATA_REFRESH_TYPE_UNSPECIFIED
  • SLIDING_WINDOW
  • CUSTOM_SLIDING_WINDOW
enumDescriptions
  • The data source won't support data auto refresh, which is default value.
  • The data source supports data auto refresh, and runs will be scheduled for the past few days. Does not allow custom values to be set for each transfer config.
  • The data source supports data auto refresh, and runs will be scheduled for the past few days. Allows custom values to be set for each transfer config.
typestring
dataSourceId
descriptionData source id.
typestring
defaultDataRefreshWindowDays
descriptionDefault data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
formatint32
typeinteger
defaultSchedule
descriptionDefault data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`.
typestring
defaultScheduleOptions
$refScheduleOptions
descriptionDefault values for options customizing the data transfer schedule.
description
descriptionUser friendly data source description string.
typestring
displayName
descriptionUser friendly data source name.
typestring
helpUrl
descriptionUrl for the help document for this data source.
typestring
isInternal
descriptionOutput only. Indicates if this is an internal data source. This field is be set to true if the data source owner project is an internal project. Otherwise, it is set to false. Ignored by server on input.
readOnlyTrue
typeboolean
manualRunScheduleType
descriptionThe manual run scheduling options
enum
  • MANUAL_RUN_SCHEDULE_TYPE_UNSPECIFIED
  • MANUAL_RUN_DISABLED
  • SCHEDULE_BACKFILL
  • REFRESH_TRANSFER
  • REFRESH_PROJECTION
enumDescriptions
  • Type unspecified
  • Do not allow schedule manual runs
  • Schedule transfer runs by showing a date range picker
  • Simply refresh the transfer without a run date
  • Refresh the Projection transfer without a run date
typestring
manualRunsDisabled
descriptionDisables backfilling and manual run scheduling for the data source.
typeboolean
maximumInflightTransferRuns
descriptionMaximum inflight runs for this data source.
formatint64
typestring
minimumScheduleInterval
descriptionThe minimum interval for scheduler to schedule runs.
formatgoogle-duration
typestring
name
descriptionOutput only. Data source resource name.
readOnlyTrue
typestring
noOverlappedRuns
descriptionTransfer runs will not be processed in parallel, so there will be only one active run (pending or running) allowed for a given time.
typeboolean
parameters
descriptionData source parameters.
items
$refDataSourceParameter
typearray
partnerLegalName
descriptionPartner's legal name of this data source
typestring
redirectUrl
descriptionRedirect URL to complete transfer config setup for 3rd party data sources.
typestring
runTimeDeduplication
descriptionMethod used to de-duplicate run-times when batch scheduling is performed. If not specified, a deduplication by DAY will be applied.
enum
  • RUN_TIME_DEDUPLICATION_UNSPECIFIED
  • DISABLED
  • TEMPLATED_PARAMETERS
  • MINUTE
  • HOUR
  • DAY
  • MONTH
  • YEAR
enumDescriptions
  • No method specified and default de-duplication by DAY will be applied.
  • De-duplication is explicitly disabled.
  • Compare values of templated transfer parameters evaluated for each run-time.
  • Compare run-times with a precision up to a minute.
  • Compare run-times with a precision up to an hour.
  • Compare run-times with a precision up to a day.
  • Compare run-times with a precision up to a month.
  • Compare year of each run-time.
typestring
runTimeNormalized
descriptionIndicates that the normalized runtime, instead of the granular runtime, should be used.
typeboolean
scopes
descriptionApi auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
items
typestring
typearray
supportServiceAccount
descriptionOutput only. Indicates if the data source supports service account to authorize data transfer.
readOnlyTrue
typeboolean
supportsCmek
descriptionSpecifies whether the data source supports using CMEK keys to encrypt data.
typeboolean
supportsCustomSchedule
descriptionSpecifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule.
typeboolean
supportsMultipleTransfers
deprecatedTrue
descriptionDeprecated. This field has no effect.
typeboolean
transferType
deprecatedTrue
descriptionDeprecated. This field has no effect.
enum
  • TRANSFER_TYPE_UNSPECIFIED
  • BATCH
  • STREAMING
enumDescriptions
  • Invalid or Unknown transfer type placeholder.
  • Batch data transfer.
  • Streaming data transfer. Streaming data source currently doesn't support multiple transfer configs per project.
typestring
updateDeadlineSeconds
descriptionThe number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
formatint32
typeinteger
useNotNormalizedRunTime
deprecatedTrue
descriptionDeprecated. This field has no effect.
typeboolean
typeobject
DataSourceDefinition
descriptionRepresents the data source definition.
idDataSourceDefinition
properties
allowJobsCreatePermissions
descriptionIndicate if it is allowed to loosening the permission check for this data source to check bigquery.jobs.create permission if the request user doesn't have transfer.* permission for some API calls such as create, update, delete and get transfer config.
typeboolean
allowOptionalDestination
descriptionIndicate if empty destination is allowed for transfer configs of data source.
typeboolean
alwaysUseUserCredentials
descriptionIff true, this data source only sends job requests with use_user_credentials, and it does not add the P4SA to the destination dataset during CreateTransferConfig or UpdateTransferConfig.
typeboolean
backfillBlacklist
additionalProperties
typestring
descriptionProjects for which backfill is disabled. Key is the project id, value is not used
typeobject
blacklistedProjects
descriptionProject numbers for which transfer service will be prohibited. These projects will not even see the data source in transfers tab, and all their configs will not be scheduled.
items
formatint64
typestring
typearray
dataSource
$refDataSource
descriptionData source metadata.
disabled
descriptionIs data source disabled? If true, data_source is not visible. API will also stop returning any data transfer configs and/or runs associated with the data source. This setting has higher priority than whitelisted_project_ids.
typeboolean
endpoint
descriptionEndpoint for the data source for various operations (browse, more in the future). Currently only blade endpoint is supported. If "{location}" is found in the value, then that means, data source wants to handle calls separately in different regions. We will replace {location} with the actual service location, as the actual endpoint. For example, blade:cloud.hosted.datanow.api.clh.datanowclh-staging-qual-{location} could become blade:cloud.hosted.datanow.api.clh.datanowclh-staging-qual-us-central1. If "{location}" is not found, then we will use the input value as endpoint.
typestring
endpointOptions
$refEndpointOptions
descriptionOptions for endpoint.
exportMetricsToCloudMonarch
descriptionA temporary flag to control which data sources can write dts metrics to cloud monarch. TODO(b/176839544) Remove this flag after dts cloud monitoring is generally available.
typeboolean
freeDataSource
descriptionIs data source free. This means that projects do not require billing to be enabled.
typeboolean
labels
additionalProperties
typestring
descriptionUser labels to add to the scheduled runs.
typeobject
name
descriptionIdentifier. The resource name of the data source definition. Data source definition names have the form `projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}`.
typestring
perProjectMinimumScheduleInterval
additionalProperties
formatgoogle-duration
typestring
descriptionPer project id minimum schedule interval overrides. Key is the project id and Value is a time interval duration.
typeobject
perProjectRunDelay
additionalProperties
formatgoogle-duration
typestring
descriptionOverrides per_project_run_delay for a given project. Key is the project id.
typeobject
perProjectRunTimeOffset
additionalProperties
formatgoogle-duration
typestring
descriptionOverrides per_project_run_time_offset for a given project. Key is the project id.
typeobject
publicDataSource
descriptionIs data source publicly available.
typeboolean
pubsubEncryptionConfig
$refPubsubEncryptionConfig
descriptionThe Pub/Sub messages encryption configuration.
refreshDuration
descriptionAmount of time after schedule_time to keep checking a run. Only applicable for automatically scheduled runs on data sources supporting continuous data refresh.
formatgoogle-duration
typestring
refreshInterval
descriptionFor data sources that support continuous data refresh, how often to recheck recent runs for new data. Use 0 if not supported.
formatgoogle-duration
typestring
runDelay
descriptionThe delay between the schedule times of transfer runs for the same transfer config. Default delay is 15 seconds.
formatgoogle-duration
typestring
runTimeOffset
descriptionDuration which should be added to schedule_time to calculate run_time when job is scheduled. Only applicable for automatically scheduled transfer runs. Used to start a run early on a data source that supports continuous data refresh to compensate for unknown timezone offsets. Use a negative number to start a run late for data sources not supporting continuous data refresh.
formatgoogle-duration
typestring
serviceAccount
descriptionWhen service account is specified, BigQuery will share created dataset with the given service account. Also, this service account will be eligible to perform status updates and message logging for data transfer runs for the corresponding data_source_id.
typestring
serviceAccountId
descriptionGaia id of the service account. It's ok to set either of the parameters. Also it is ok to set both parameters, but they must really correspond to each other, otherwise config will be discarded during validation.
formatint64
typestring
supportEmail
descriptionSupport e-mail address of the OAuth client's Brand, which contains the consent screen data.
typestring
supportServiceAccount
descriptionIndicate if service account authentication is supported for the data source. Defaults to false.
typeboolean
supportedLocationIds
descriptionSupported location_ids used for deciding in which locations Pub/Sub topics need to be created. If custom Pub/Sub topics are used and they contains '{location}', the location_ids will be used for validating the topics by replacing the '{location}' with the individual location in the list. The valid values are the "location_id" field of the response of `GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations` In addition, if the data source needs to support all available regions, supported_location_ids can be set to "global" (a single string element). When "global" is specified: 1) the data source implementation is supposed to stage the data in proper region of the destination dataset; 2) Data source developer should be aware of the implications (e.g., network traffic latency, potential charge associated with cross-region traffic, etc.) of supporting the "global" region;
items
typestring
typearray
supportsPushQueue
descriptionIf set, the data source supports the push queue model for processing transfer runs and subtasks instead of Pub/Sub (go/dts-onto-boq).
typeboolean
transferConfigPubsubTopic
descriptionThe Pub/Sub topic to use for broadcasting a message for transfer config. If empty, a message will not be broadcasted. Both this topic and transfer_run_pubsub_topic are auto-generated if none of them is provided when creating the definition. It is recommended to provide transfer_config_pubsub_topic if a user-owned transfer_run_pubsub_topic is provided. Otherwise, it will be set to empty. If "{location}" is found in the value, then that means, data source wants to handle message separately for datasets in different regions. We will replace {location} with the actual dataset location, as the actual topic name. For example, projects/connector/topics/scheduler-{location} could become projects/connector/topics/scheduler-us. If "{location}" is not found, then we will use the input value as topic name.
typestring
transferRunPubsubTopic
descriptionThe Pub/Sub topic to be used for broadcasting a message when a transfer run is created. Both this topic and transfer_config_pubsub_topic can be set to a custom topic. By default, both topics are auto-generated if none of them is provided when creating the definition. However, if one topic is manually set, the other topic has to be manually set as well. The only difference is that transfer_run_pubsub_topic must be a non-empty Pub/Sub topic, but transfer_config_pubsub_topic can be set to empty. The comments about "{location}" for transfer_config_pubsub_topic apply here too.
typestring
transferRunsPushQueue
descriptionThe name of the push queue to dispatch transfer runs if the data source supports the push queue model (go/dts-onto-boq). Only applicable if supports_push_queue is true.
typestring
transferSubtaskOverallStateNotification
descriptionThe transfer subtask overall state notification setting.
enum
  • TRANSFER_SUBTASK_OVERALL_STATE_NOTIFICATION_UNSPECIFIED
  • ON_SUCCESS
  • ON_SUCCESS_OR_FAILURE
enumDescriptions
  • Type unspecified. This defaults to `ON_SUCCESS` at application layer for backward compatibility.
  • A notification will be sent only when all subtasks succeed.
  • A notification will be sent when either of the condition is met: 1) All subtasks succeed. 2) At least one subtask fails.
typestring
transferSubtaskPubsubTopic
descriptionRequired. The Pub/Sub topic to use for broadcasting a message for transfer subtask. The comments about "{location}" for transfer_config_pubsub_topic apply here too.
typestring
transferSubtasksPushQueue
descriptionThe name of the push queue to dispatch transfer subtasks if the data source supports the push queue model (go/dts-onto-boq). Only applicable if supports_push_queue is true.
typestring
userOwnedTopics
descriptionRequired. Are Pub/Sub topics manually-set and owned by data source owner. By default, DTS automatically generates various Pub/Sub topics if no topics are provided when creating the data source definition. The Pub/Sub topics are also allowed to be changed after data source creation. In that case, the original auto-generated topics will be deleted.
typeboolean
whitelistedProjects
descriptionProject numbers for which data source should be visible. Empty means "all projects". This parameter is useful for trusted testers.
items
formatint64
typestring
typearray
typeobject
DataSourceParameter
descriptionA parameter used to define custom fields in a data source definition.
idDataSourceParameter
properties
allowedValues
descriptionAll possible values for the parameter.
items
typestring
typearray
dataContexts
descriptionRequired if special cares are needed for this parameter.
items
enum
  • DATA_CONTEXT_UNSPECIFIED
  • DATA_CONTEXT_CORE_CONTENT
  • DATA_CONTEXT_SENSITIVE
enumDescriptions
  • Type unspecified.
  • Customer Core Content like query text.
  • Sensitive content like Amazon S3 secrets.
typestring
typearray
defaultValue
descriptionDefault value that will be set in the UI for new transfer configs.
typestring
deprecated
descriptionIf true, it should not be used in new transfers, and it should not be visible to users.
typeboolean
description
descriptionParameter description.
typestring
displayName
descriptionParameter display name in the user interface.
typestring
displaySection
descriptionAllows to group related parameters into display sections. This approach can be further extended by allowing the order of the sections to be specified as a list parameter of the data source.
typestring
displaySuffix
descriptionDescription that will display inline after the original field - this will make the previous input field smaller and display some text after it. For instance, use this to display a url suffix so the user can input a subdomain. e.g. | [INPUT] .google.com |
typestring
fields
descriptionDeprecated. This field has no effect.
items
$refDataSourceParameter
typearray
hidden
descriptionIf true, this parameter will not be exposed to users. However, incoming requests with a parameter that's hidden will be accepted. e.g. CreateTransferConfigRequest.
typeboolean
immutable
descriptionCannot be changed after initial creation.
typeboolean
isSensitive
deprecatedTrue
descriptionDeprecated. This field has no effect.
typeboolean
maxValue
descriptionFor integer and double values specifies maximum allowed value.
formatdouble
typenumber
minValue
descriptionFor integer and double values specifies minimum allowed value.
formatdouble
typenumber
ownerRestricted
descriptionIff true, only the owner of the transfer config can modify this parameter.
typeboolean
paramId
descriptionParameter identifier.
typestring
paramWhitelistedProjects
descriptionContains a list of projects which can access this data source parameter. Empty list of no list means the data source parameter is open to all projects.
items
formatint64
typestring
typearray
recurse
descriptionDeprecated. This field has no effect.
typeboolean
repeated
descriptionDeprecated. This field has no effect.
typeboolean
required
descriptionIs parameter required.
typeboolean
type
descriptionParameter type.
enum
  • TYPE_UNSPECIFIED
  • STRING
  • INTEGER
  • DOUBLE
  • BOOLEAN
  • RECORD
  • PLUS_PAGE
  • LIST
enumDescriptions
  • Type unspecified.
  • String parameter.
  • Integer parameter (64-bits). Will be serialized to json as string.
  • Double precision floating point parameter.
  • Boolean parameter.
  • Deprecated. This field has no effect.
  • Page ID for a Google+ Page.
  • List of strings parameter.
typestring
validationDescription
descriptionDescription of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
typestring
validationHelpUrl
descriptionURL to a help document to further explain the naming requirements.
typestring
validationRegex
descriptionRegular expression which can be used for parameter validation.
typestring
typeobject
DatasetReference
descriptionIdentifier for a dataset.
idDatasetReference
properties
datasetId
descriptionRequired. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
typestring
projectId
descriptionOptional. The ID of the project containing this dataset.
typestring
typeobject
DtsTenantProject
descriptionDefinition of a dts tenant project.
idDtsTenantProject
properties
name
descriptionThe resource name of the dts tenant project. Format: projects/{project_id}/locations/{location_id}/dtsTenantProjects/{tenant_id} {project_id} is the consumer project number. {tenant_id} is the user specified id for the dts tenant project. Note this is NOT the GCP project id.
typestring
project
descriptionOutput only. Identifier of the dts tenant project in the form `projects/{number}`. For example "projects/123456".
readOnlyTrue
typestring
state
descriptionOutput only. State of tenant project.
enum
  • STATE_UNSPECIFIED
  • ACTIVE
  • FAILED
enumDescriptions
  • Unspecified status is the default unset value.
  • Active tenant project.
  • Tenant project creation or deletion has failed.
readOnlyTrue
typestring
typeobject
EmailPreferences
descriptionRepresents preferences for sending email notifications for transfer run events.
idEmailPreferences
properties
enableFailureEmail
descriptionIf true, email notifications will be sent on transfer run failures.
typeboolean
typeobject
Empty
descriptionA 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); }
idEmpty
properties
typeobject
EnableDataTransferServiceRequest
descriptionA request to enable data transfer service for a project.
idEnableDataTransferServiceRequest
properties
typeobject
EncryptionConfiguration
descriptionRepresents the encryption configuration for a transfer.
idEncryptionConfiguration
properties
kmsKeyName
descriptionThe name of the KMS key used for encrypting BigQuery data.
typestring
typeobject
EndpointOptions
descriptionOptions for endpoint.
idEndpointOptions
properties
mapMultiRegionToCollapsed
descriptionFlag to indicate the region replacement for the endpoint will map multi region into the collapsed region, i.e., us -> us-central1, eu -> europe-west4.
typeboolean
typeobject
EnrollDataSourcesRequest
descriptionA request to enroll a set of data sources so they are visible in the BigQuery UI's `Transfer` tab.
idEnrollDataSourcesRequest
properties
dataSourceIds
descriptionData sources that are enrolled. It is required to provide at least one data source id.
items
typestring
typearray
typeobject
EventDrivenSchedule
descriptionOptions customizing EventDriven transfers schedule.
idEventDrivenSchedule
properties
pubsubSubscription
descriptionPub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project}/subscriptions/{subscription}
typestring
typeobject
Experiment
descriptionRepresents experiment to corresponding to the project.
idExperiment
properties
enabled
descriptionThe boolean of enabled.
typeboolean
name
descriptionRequired. The name of flag. Format: `projects/{project_id}/locations/{location_id}/experiments/{flag_name}`
typestring
typeobject
ExperimentInfo
descriptionInformation related to mendel experiments.
idExperimentInfo
properties
enabledExperimentIds
descriptionExperiment ids that are selected to be logged.
items
formatint32
typeinteger
typearray
enabledExperiments
descriptionExperiment flag names that are enabled.
items
typestring
typearray
typeobject
FieldElementType
descriptionRepresents the type of a field element.
idFieldElementType
properties
type
descriptionRequired. The type of a field element. For more information, see ImportedDataInfo.FieldSchema.type.
enum
  • TYPE_UNSPECIFIED
  • STRING
  • INTEGER
  • FLOAT
  • RECORD
  • BYTES
  • BOOLEAN
  • TIMESTAMP
  • DATE
  • TIME
  • DATETIME
  • NUMERIC
  • GEOGRAPHY
  • BIGNUMERIC
  • JSON
  • RANGE
enumDescriptions
  • Illegal value.
  • 64K, UTF8.
  • 64-bit signed.
  • 64-bit IEEE floating point.
  • Aggregate type.
  • 64K, Binary.
  • 2-valued.
  • 64-bit signed usec since UTC epoch.
  • Civil date - Year, Month, Day.
  • Civil time - Hour, Minute, Second, Microseconds.
  • Combination of civil date and civil time.
  • Numeric type with 38 decimal digits of precision and 9 decimal digits of scale.
  • Geography object (go/googlesql_geography).
  • BigNumeric type with granularity 10^-38, min value -2^255 x 10^-38 and max value roughly (2^255 - 1) x 10^-38.
  • JSON type.
  • RANGE type.
typestring
typeobject
FieldSchema
descriptionDefines schema of a field in the imported data.
idFieldSchema
properties
description
descriptionDescription for this field.
typestring
fieldName
descriptionField name. Matches: A-Za-z_{0,127}
typestring
isRepeated
descriptionIs field repeated.
typeboolean
isRequired
descriptionIs field required. Used only if `is_repeated` is set to false.
typeboolean
rangeElementType
$refFieldElementType
descriptionRequired if the type of the field is RANGE. The value can be one of the following: * `DATE` * `DATETIME` * `TIMESTAMP`
schema
$refRecordSchema
descriptionPresent iff type == RECORD.
type
descriptionField type
enum
  • TYPE_UNSPECIFIED
  • STRING
  • INTEGER
  • FLOAT
  • RECORD
  • BYTES
  • BOOLEAN
  • TIMESTAMP
  • DATE
  • TIME
  • DATETIME
  • NUMERIC
  • GEOGRAPHY
  • BIGNUMERIC
  • JSON
  • RANGE
enumDescriptions
  • Illegal value.
  • 64K, UTF8.
  • 64-bit signed.
  • 64-bit IEEE floating point.
  • Aggregate type.
  • 64K, Binary.
  • 2-valued.
  • 64-bit signed usec since UTC epoch.
  • Civil date - Year, Month, Day.
  • Civil time - Hour, Minute, Second, Microseconds.
  • Combination of civil date and civil time.
  • Numeric type with 38 decimal digits of precision and 9 decimal digits of scale.
  • Geography object (go/googlesql_geography).
  • BigNumeric type with granularity 10^-38, min value -2^255 x 10^-38 and max value roughly (2^255 - 1) x 10^-38.
  • JSON type.
  • RANGE type.
typestring
typeParameters
$refTypeParameters
descriptionType Parameters for NUMERIC, STRING or BYTES types
typeobject
FinishRunRequest
descriptionA request to finish a run.
idFinishRunRequest
properties
typeobject
GetOrCreateDtsTenantProjectRequest
descriptionRepresents a request of GetOrCreateDtsTenantProject method.
idGetOrCreateDtsTenantProjectRequest
properties
tenantId
descriptionRequired. The ID for the dts tenant project, which will become the final component of the dts tenant project's resource name. The id must be unique within the parent, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?. The id must NOT be a UUID-like string.
typestring
typeobject
ImportedDataInfo
descriptionDescribes data which should be imported.
idImportedDataInfo
properties
clustering
$refClustering
descriptionOne or more fields on which data should be clustered.
columnAddition
descriptionEnable new column addition.
typeboolean
createDisposition
descriptionSpecifies whether the job is allowed to create new tables.
enum
  • CREATE_DISPOSITION_UNSPECIFIED
  • CREATE_NEVER
  • CREATE_IF_NEEDED
enumDescriptions
  • The default createDispostion
  • The table must already exist. If it does not, a 'notFound' error is returned in the job result.
  • If the table does not exist, BigQuery creates the table.
typestring
dataVersion
descriptionData version associated with the data for this job. Used for deduplicating and ordering jobs.
typestring
deleteSourceFiles
descriptionWhen set BigQuery DTS will perform best effort delete of the source files after the BigQuery load job succeeds.
typeboolean
destinationExpirationTime
descriptionThe time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
formatgoogle-datetime
typestring
destinationTableDescription
descriptionThe description of a destination table. This can be several sentences or paragraphs describing the table contents in detail.
typestring
destinationTableId
descriptionTable where results should be written.
typestring
destinationTableKmsKey
descriptionOptional. Optional cloud KMS encryption key. When not specified default encryption is used.
typestring
jobProjectId
descriptionIf specified, jobs are billed to this project_id, rather than project_id of the TransferRun.
typestring
maximumBytesBilled
descriptionOptional maximum bytes billed. If specified, query job will fail if exceeding the maximum bytes billed.
formatint64
typestring
parameters
descriptionA list of named parameters for query job.
items
$refQueryParameter
typearray
queryType
descriptionQuery type based on the enum, e.g. DML.
enum
  • QUERY_JOB_TYPE_UNSPECIFIED
  • DEFAULT_QUERY
  • DML
enumDescriptions
  • Query job type unspecified
  • Regular query
  • DML
typestring
rangePartitioning
$refRangePartitioning
descriptionRange partitioning information for destination table (present only for partitioned tables).
requestedJobId
descriptionOptional parameter allowing to assign a specific ID to BigQuery job loading the data. When set, only a single BigQuery job can be started per ImportedDataInfo and the job will not be retried if failed. When not specified, DTS will generate the ID and can start more than one BigQuery job to load the data in ImportedDataInfo. This field is currently used only by transfer/resource_state_controller.cc and is not expected to be set by a datasource directly.
typestring
schemaAutodetection
descriptionEnable schema autodetection.
typeboolean
sql
descriptionSQL query to run. When empty, API checks that there is only one table_def specified and loads this table. Only GoogleSQL queries are accepted. Legacy SQL is not allowed.
typestring
tableDefs
descriptionWhen used WITHOUT the "sql" parameter, describes the schema of the destination table. When used WITH the "sql" parameter, describes tables with data stored outside of BigQuery.
items
$refTableDefinition
typearray
thinmint
descriptionSerialized thinmint that is required when data is stored on Colossus or Placer. If not populated, then thinmint from the request is used.
formatbyte
typestring
timePartitioning
$refTimePartitioning
descriptionTime partitioning information for destination table (present only for partitioned tables).
userDefinedFunctions
descriptionInline code for User-defined function resources. Ignored when "sql" parameter is empty.
items
typestring
typearray
writeDisposition
descriptionSpecifies the action if the destination table already exists.
enum
  • WRITE_DISPOSITION_UNSPECIFIED
  • WRITE_TRUNCATE
  • WRITE_APPEND
  • WRITE_EMPTY
enumDescriptions
  • The default writeDispostion
  • overwrites the table data.
  • the data is appended to the table. Note duplication might happen if this mode is used.
  • This job should only be writing to empty tables.
typestring
typeobject
IsDataTransferServiceEnabledRequest
descriptionA request to determine whether data transfer is enabled for the project.
idIsDataTransferServiceEnabledRequest
properties
typeobject
IsDataTransferServiceEnabledResponse
descriptionA response to indicate whether data transfer service is enabled for the project.
idIsDataTransferServiceEnabledResponse
properties
enabled
descriptionIndicates whether the data transfer service is enabled for the project.
typeboolean
reason
descriptionA string that contains additional information about why the service is deemed not enabled. This is only available when `enable` is false.
typestring
typeobject
JobCounts
descriptionMessage describing the count of jobs in various success and execution states.
idJobCounts
properties
active
descriptionThe count of jobs that are currently executing.
formatint32
typeinteger
failed
descriptionThe count of jobs that finished and had an error.
formatint32
typeinteger
idle
descriptionThe count of jobs that are neither finished nor running. For example, these jobs could be waiting on a condition to change to start execution, such as when the number of concurrently active jobs is constrained.
formatint32
typeinteger
succeeded
descriptionThe count of jobs that finished and succeeded (do not have an error).
formatint32
typeinteger
typeobject
KeystoreEncryption
descriptionKeystore encryption configuration.
idKeystoreEncryption
properties
keystoreConfigId
descriptionKeystore config ID.
formatint32
typeinteger
keystoreKeymasterServiceKey
descriptionKeystore keymaster service key name.
typestring
typeobject
ListDataSourceDefinitionsResponse
descriptionReturns a list of supported data source definitions.
idListDataSourceDefinitionsResponse
properties
dataSourceDefinitions
descriptionList of supported data source definitions.
items
$refDataSourceDefinition
typearray
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourceDefinitionsRequest.page_token` to request the next page of the list results.
readOnlyTrue
typestring
typeobject
ListDataSourcesResponse
descriptionReturns list of supported data sources and their metadata.
idListDataSourcesResponse
properties
dataSources
descriptionList of supported data sources and their transfer settings.
items
$refDataSource
typearray
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourcesRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
typeobject
ListExperimentsResponse
descriptionRepresents a response of all the experiments of the project.
idListExperimentsResponse
properties
experiments
descriptionOutput only. The name of requested project that consumes the dts experiments. Format: `projects/{project_id}/locations/{location_id}/experiments`
items
$refExperiment
readOnlyTrue
typearray
typeobject
ListLocationsResponse
descriptionThe response message for Locations.ListLocations.
idListLocationsResponse
properties
locations
descriptionA list of locations that matches the specified filter in the request.
items
$refLocation
typearray
nextPageToken
descriptionThe standard List next-page token.
typestring
typeobject
ListTransferConfigsResponse
descriptionThe returned list of pipelines in the project.
idListTransferConfigsResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
transferConfigs
descriptionOutput only. The stored pipeline transfer configurations.
items
$refTransferConfig
readOnlyTrue
typearray
typeobject
ListTransferLogsResponse
descriptionThe returned list transfer run messages.
idListTransferLogsResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `GetTransferRunLogRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
transferMessages
descriptionOutput only. The stored pipeline transfer messages.
items
$refTransferMessage
readOnlyTrue
typearray
typeobject
ListTransferRunsResponse
descriptionThe returned list of pipelines in the project.
idListTransferRunsResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
transferRuns
descriptionOutput only. The stored pipeline transfer runs.
items
$refTransferRun
readOnlyTrue
typearray
typeobject
ListTransferSubtasksResponse
descriptionThe returned list of subtasks for the particular transfer run.
idListTransferSubtasksResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
subtasks
descriptionOutput only. The stored subtasks.
items
$refTransferSubtask
readOnlyTrue
typearray
typeobject
Location
descriptionA resource that represents a Google Cloud location.
idLocation
properties
displayName
descriptionThe friendly name for this location, typically a nearby city name. For example, "Tokyo".
typestring
labels
additionalProperties
typestring
descriptionCross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
typeobject
locationId
descriptionThe canonical id for this location. For example: `"us-east1"`.
typestring
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata. For example the available capacity at the given location.
typeobject
name
descriptionResource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
typestring
typeobject
Log3PTosAcceptedRequest
descriptionA request to log a consent event when users accept the TOS before creating or changing a transfer config for a 3rd party data source.
idLog3PTosAcceptedRequest
properties
auditRenderDataToken
descriptionAlternatively, the client can replace build label, build cl and language code with an audit render data token which includes all three pieces of info in an encrypted string.
typestring
buildCl
descriptionBigQuery client build cl (rollup Cl).
formatint64
typestring
buildLabel
descriptionBigQuery client build label.
typestring
dataSourceId
description3rd party data source id.
typestring
datasetId
descriptionThe user-selected dataset id.
typestring
languageCode
descriptionThe language code in which the BigQuery UI was presented to the user. The language code has to conform to the CLDR (https://unicode.org/cldr/) specification (which is based on the BCP 47) identifier system (see cs/symbol:com.google.i18n.identifiers.LanguageCode for more information about the format of the supported language codes).
typestring
uiContext
descriptionIndicates the UI context when the requests is made.
enum
  • UI_CONTEXT_UNSPECIFIED
  • CREATING_CONFIG
  • EDITING_CONFIG
enumDescriptions
  • Type unspecified.
  • Creating a transfer config.
  • Editing a transfer config.
typestring
typeobject
LogTransferRunMessagesRequest
descriptionA request to add transfer status messages to the run.
idLogTransferRunMessagesRequest
properties
transferMessages
descriptionMessages to append.
items
$refTransferMessage
typearray
typeobject
ManualSchedule
descriptionOptions customizing manual transfers schedule.
idManualSchedule
properties
typeobject
MonitorBigQueryJobsRequest
descriptionA request to monitor an existing BigQuery load job.
idMonitorBigQueryJobsRequest
properties
cloudRegionName
descriptionCloudRegion name for HelixJob's location. It will override the region inferred from transfer run name if specified. Helix Cloudregion enum is not used here as proto2 enum is not supported in proto3.
typestring
jobs
descriptionJobs to be monitored.
items
$refBigQueryJobMonitoringInfo
typearray
thinmint
descriptionSerialized thinmint that is required when data is stored on Colossus or Placer.
formatbyte
typestring
useUserCredentials
descriptionWhen this is set to true, we use the user credentials to monitor BigQuery job.
typeboolean
userCredentials
descriptionUser credentials which should be used to start/monitor BigQuery jobs. If not specified, then jobs are started using data source service account credentials. This may be OAuth token or JWT token.
formatbyte
typestring
typeobject
ParquetOptions
descriptionParquet Options for load and make external tables.
idParquetOptions
properties
enableListInference
descriptionOptional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
typeboolean
enumAsString
descriptionOptional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
typeboolean
mapTargetType
descriptionOptional. Indicates how to represent a Parquet map if present.
enum
  • MAP_TARGET_TYPE_UNSPECIFIED
  • ARRAY_OF_STRUCT
enumDescriptions
  • In this mode, the map will have the following schema: struct map_field_name { repeated struct key_value { key value } }.
  • In this mode, the map will have the following schema: repeated struct map_field_name { key value }.
typestring
typeobject
PartitionTransferConfigsRequest
descriptionA request to partition data transfer configs, so that they can be streamed in parallel.
idPartitionTransferConfigsRequest
properties
dataSourceIds
descriptionList of data source ids for which data transfer configs should be returned.
items
typestring
typearray
desiredPartitionSizeBytes
descriptionDesired partition data size in bytes.
formatint64
typestring
typeobject
PartitionTransferConfigsResponse
descriptionRepresents partitioning info that can be used to stream transfer configs in parallel. Returned token is valid for at least 2 hours.
idPartitionTransferConfigsResponse
properties
partitions
descriptionSet of partitions. Any subset of them can be passed to StreamTransferConfigs method.
items
typestring
typearray
token
descriptionToken that must be passed to StreamTransferConfigs method.
typestring
typeobject
PartitionTransferRunsRequest
descriptionA request to partition data transfer runs so that they can be streamed in parallel.
idPartitionTransferRunsRequest
properties
dataSourceIds
descriptionList of data source ids for which data transfer configs should be returned.
items
typestring
typearray
desiredPartitionSizeBytes
descriptionDesired partition data size in bytes.
formatint64
typestring
minScheduleTime
descriptionWhen specified, adds an extra filter to select runs scheduled on or after the time specified.
formatgoogle-datetime
typestring
states
descriptionList of run states to return.
items
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
typestring
typearray
typeobject
PartitionTransferRunsResponse
descriptionRepresents partitioning info that can be used to stream transfer runs in parallel. Returned token is valid for at least 2 hours.
idPartitionTransferRunsResponse
properties
partitions
descriptionSet of partitions. Any subset of them can be passed to StreamTransferRuns method.
items
typestring
typearray
token
descriptionToken that must be passed to StreamTransferRuns method.
typestring
typeobject
PlayDataSourceUsageEntry
descriptionA usage entry of Play usage for a transfer run.
idPlayDataSourceUsageEntry
properties
playPackages
descriptionRequired. The packages transferred in the run.
items
typestring
typearray
typeobject
PubsubEncryptionConfig
descriptionThe encryption option for Pub/Sub messages. The default value means messages are not encrypted. If encryption is enabled, the Pub/Sub message data is encrypted after serialization, and message attributes key/value pairs are set to provide encryption metadata. For examples: -- Unencrypted -- PubsubMessage { "data": serialized(TransferRun message) "attributes": {} } -- Encrypted with Keystore -- PubsubMessage { "data": encrypted(serialized(TransferRun message)) "attributes": { "keystore_config_id": 72667, "keystore_keymaster_service_key": "some_key_name" } } This option curerently applies to transfer_run_pubsub_topic and transfer_subtask_pubsub_topic.
idPubsubEncryptionConfig
properties
keystoreEncryption
$refKeystoreEncryption
descriptionEncryption using Keystore keys.
typeobject
QueryParameter
descriptionA user-specified parameter for query execution.
idQueryParameter
properties
parameterName
descriptionName of the parameter.
typestring
typeKind
descriptionThe type of the parameter. Only Timestamp is supported now. Default is timestamp.
enum
  • TYPE_KIND_UNSPECIFIED
  • TYPE_INT64
  • TYPE_BOOL
  • TYPE_FLOAT_64
  • TYPE_STRING
  • TYPE_BYTES
  • TYPE_TIMESTAMP
  • TYPE_DATE
  • TYPE_TIME
  • TYPE_DATETIME
  • TYPE_GEOGRAPHY
  • TYPE_ARRAY
  • TYPE_STRUCT
  • TYPE_NUMERIC
  • TYPE_BIGNUMERIC
  • TYPE_JSON
  • TYPE_RANGE
enumDescriptions
  • Invalid type.
  • A string in decimal format.
  • A boolean "false" or "true".
  • A number, or string "NaN", "Infinity" or "-Infinity".
  • A string value.
  • A base64 string per RFC 4648, section 4.
  • An RFC 3339 timestamp with mandatory "Z" time zone string: 1985-04-12T23:20:50.52Z
  • An RFC 3339 full-date format string: 1985-04-12
  • An RFC 3339 partial-time format string: 23:20:50.52
  • An RFC 3339 full-date "T" partial-time: 1985-04-12T23:20:50.52
  • A WKT
  • A list with types matching Type.array_type.
  • A list with fields of type Type.struct_type[i].
  • A string in decimal format.
  • A string in decimal format.
  • A json value.
  • A range value.
typestring
value
descriptionValue of the parameter.
typestring
typeobject
Range
descriptionDefines the ranges for range partitioning.
idRange
properties
end
descriptionRequired. The end of range partitioning, exclusive. This field is an INT64 value represented as a string.
typestring
interval
descriptionRequired. The width of each interval. This field is an INT64 value represented as a string.
typestring
start
descriptionRequired. The start of range partitioning, inclusive. This field is an INT64 value represented as a string.
typestring
typeobject
RangePartitioning
idRangePartitioning
properties
field
descriptionRequired. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED.
typestring
range
$refRange
descriptionDefines the ranges for range partitioning.
typeobject
RecordSchema
descriptionDescribes schema of the data to be ingested.
idRecordSchema
properties
fields
descriptionOne field per column in the record.
items
$refFieldSchema
typearray
typeobject
RecordTransferRunBillingMeasurementRequest
descriptionRequest to record transfer run billing measurement.
idRecordTransferRunBillingMeasurementRequest
properties
dataSourceId
descriptionstring to indicate the data source type
typestring
measurementEntry
$refTransferRunBillingMeasurementEntry
descriptionA measurement entry to record.
playDataSourceUsageEntry
$refPlayDataSourceUsageEntry
descriptionA usage entry to record Play usage
typeobject
ScheduleOptions
descriptionOptions customizing the data transfer schedule.
idScheduleOptions
properties
disableAutoScheduling
descriptionIf true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
typeboolean
endTime
descriptionDefines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.
formatgoogle-datetime
typestring
maxScheduledRuns
descriptionLimits the total number of times a transfer config can be started per schedule. Currently supported values: 0 - infinite times, 1 - run once. This field does not limit the number of times a transfer can be started manually.
formatint32
typeinteger
startTime
descriptionSpecifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.
formatgoogle-datetime
typestring
typeobject
ScheduleOptionsV2
descriptionV2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
idScheduleOptionsV2
properties
eventDrivenSchedule
$refEventDrivenSchedule
descriptionEvent driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.
manualSchedule
$refManualSchedule
descriptionManual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.
timeBasedSchedule
$refTimeBasedSchedule
descriptionTime based transfer schedule options. This is the default schedule option.
typeobject
ScheduleTransferRunsRequest
descriptionA request to schedule transfer runs for a time range.
idScheduleTransferRunsRequest
properties
endTime
descriptionRequired. End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`.
formatgoogle-datetime
typestring
labels
additionalProperties
typestring
descriptionUser labels to add to the scheduled runs.
typeobject
startTime
descriptionRequired. Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`.
formatgoogle-datetime
typestring
typeobject
ScheduleTransferRunsResponse
descriptionA response to schedule transfer runs for a time range.
idScheduleTransferRunsResponse
properties
runs
descriptionThe transfer runs that were scheduled.
items
$refTransferRun
typearray
typeobject
SetEnabledRequest
descriptionA request to set whether data transfer is enabled or disabled for a project.
idSetEnabledRequest
properties
enabled
descriptionWhether data transfer should be enabled or disabled for the project.
typeboolean
typeobject
StartBigQueryJobsRequest
descriptionA request to start and monitor a BigQuery load job.
idStartBigQueryJobsRequest
properties
cloudRegionName
descriptionCloudRegion name for HelixJob's location. It will override the region inferred from transfer run name if specified. Helix Cloudregion enum is not used here as proto2 enum is not supported in proto3.
typestring
copyJob
descriptionDefinition for copy jobs. It is allowed for a start job request to have a mixture of ImportedDataInfo for query and load jobs, and of CopyJobInfo.
items
$refCopyJobInfo
typearray
dataSourceUris
descriptionSource URI of the transfer
items
typestring
typearray
decimalTargetTypes
descriptionSQL data types to which source decimal values are converted. This list along with the precision and scale of the decimal field determine the target type. The order of preference is NUMERIC, BIGNUMERIC, and then STRING. A type is picked if it is in this field and if it supports the given precision and scale. STRING supports all precision and scale values. If none of the provided types support the precision and scale, the type supporting the widest range in the specified list is picked. If a value exceeds the supported range when reading the data, an error will be thrown. For example: suppose decimal_target_type = ["NUMERIC", "BIGNUMERIC"]. Then if (precision,scale) is: * (38,9) -> NUMERIC; * (38,9) -> BIGNUMERIC (NUMERIC cannot hold 38 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC.
items
enum
  • DECIMAL_TARGET_TYPE_UNSPECIFIED
  • NUMERIC
  • BIGNUMERIC
  • STRING
enumDescriptions
  • Invalid type.
  • Decimal values could be converted to NUMERIC type.
  • Decimal values could be converted to BIGNUMERIC type.
  • Decimal values could be converted to STRING type.
typestring
typearray
importedData
descriptionImport jobs which should be started and monitored.
items
$refImportedDataInfo
typearray
maxParallelism
descriptionThe number of BigQuery Jobs that can run in parallel.
formatint32
typeinteger
thinmint
descriptionSerialized thinmint that is required when data is stored on Colossus or Placer.
formatbyte
typestring
useUserCredentials
descriptionWhen this is set to true, we use the user credentials to write data into BigQuery destination dataset. For example, this is used in Scheduled Query data source to force to use user credentials to write to BigQuery, instead of using the p4 service account credentials.
typeboolean
userCredentials
descriptionUser credentials which should be used to start/monitor BigQuery jobs. If not specified, then jobs are started using data source service account credentials. This may be OAuth token or JWT token.
formatbyte
typestring
typeobject
StartManualTransferRunsRequest
descriptionA request to start manual transfer runs.
idStartManualTransferRunsRequest
properties
labels
additionalProperties
typestring
descriptionUser labels to add to the backfilled runs.
typeobject
requestedRunTime
descriptionA run_time timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_run_time must be a past time and cannot include future time values.
formatgoogle-datetime
typestring
requestedTimeRange
$refTimeRange
descriptionA time_range start and end timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_time_range must be a past time and cannot include future time values.
typeobject
StartManualTransferRunsResponse
descriptionA response to start manual transfer runs.
idStartManualTransferRunsResponse
properties
runs
descriptionThe transfer runs that were created.
items
$refTransferRun
typearray
typeobject
Status
descriptionThe `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).
idStatus
properties
code
descriptionThe status code, which should be an enum value of google.rpc.Code.
formatint32
typeinteger
details
descriptionA list of messages that carry the error details. There is a common set of message types for APIs to use.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
message
descriptionA 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.
typestring
typeobject
StreamTransferConfigsRequest
descriptionA request to get data transfer configs corresponding to the given partitions.
idStreamTransferConfigsRequest
properties
partitions
descriptionSubset of partitions returned by PartitionTransferConfigs method.
items
typestring
typearray
token
descriptionToken returned by PartitionTransferConfigs method.
typestring
typeobject
StreamTransferRunsRequest
descriptionA request to get data transfer runs corresponding to the given partitions.
idStreamTransferRunsRequest
properties
partitions
descriptionSubset of partitions returned by PartitionTransferRuns method.
items
typestring
typearray
token
descriptionToken returned by PartitionTransferRuns method.
typestring
typeobject
TableDefinition
descriptionExternal table definition. These tables can be referenced with 'name' in the query and can be read just like any other table.
idTableDefinition
properties
avroOptions
$refAvroOptions
descriptionAVRO specific options.
csvOptions
$refCsvOptions
descriptionCSV specific options.
encoding
descriptionCharacter encoding of the input when applicable (CSV, JSON). Defaults to UTF8.
enum
  • ENCODING_UNSPECIFIED
  • ISO_8859_1
  • UTF8
  • UTF16BE
  • UTF16LE
  • UTF32BE
  • UTF32LE
enumDescriptions
  • Default encoding (UTF8).
  • ISO_8859_1 encoding.
  • UTF8 encoding.
  • UTF-16 BigEndian. Only support CSV files.
  • UTF-16 LittleEndian. Only support CSV files.
  • UTF-32 BigEndian. Only support CSV files.
  • UTF-32 LittleEndian. Only support CSV files.
typestring
format
descriptionDescribes the format of the data in source_uri.
enum
  • FORMAT_UNSPECIFIED
  • CSV
  • JSON
  • AVRO
  • RECORDIO
  • COLUMNIO
  • CAPACITOR
  • PARQUET
  • ORC
  • THRIFT
  • ICEBERG
  • DELTA_LAKE
enumDescriptions
  • Unspecified format. In this case, we have to infer the format from the data source.
  • CSV format.
  • Newline-delimited JSON.
  • Avro format. See https://avro.apache.org .
  • RecordIO.
  • ColumnIO.
  • Capacitor.
  • Parquet format. See https://parquet.apache.org .
  • ORC format. See https://orc.apache.org .
  • Thrift format. See https://thrift.apache.org/.
  • Iceberg format. See https://iceberg.apache.org/.
  • Delta lake format. See https://databricks.com/product/delta-lake-on-databricks.
typestring
ignoreUnknownValues
descriptionIndicates if extra values that are not represented in the table schema is allowed.
typeboolean
maxBadRecords
descriptionSpecify the maximum number of bad records that can be ignored. If bad records exceed this threshold the query is aborted.
formatint32
typeinteger
nativeSchema
descriptionOptional internal parameter with a schema in a native format used in BigQuery (TableSchema proto in helix.proto) serialized as bytes to avoid taking a dependency on helix.proto.
formatbyte
typestring
parquetOptions
$refParquetOptions
descriptionPARQUET specific options.
referenceFileSchemaUri
descriptionProvide a reference file with the reader schema. Supported formats: AVRO, PARQUET, ORC.
typestring
schema
$refRecordSchema
descriptionOptional schema for the data. When not specified for JSON and CSV formats we will try to detect it automatically.
sourceUris
descriptionURIs for the data to be imported. All URIs must be from the same storage system.
items
typestring
typearray
tableId
descriptionBigQuery table_id (required). This will be used to reference this table in the query.
typestring
thriftOptions
$refThriftOptions
descriptionTHRIFT specific options;
viewInfo
descriptionInfo to create view
items
$refViewInfo
typearray
typeobject
TableReference
descriptionDefinition for a BigQuery (fully qualified) table reference.
idTableReference
properties
datasetId
descriptionDataset id.
typestring
projectId
descriptionProject id or number.
typestring
tableId
descriptionTable id.
typestring
typeobject
ThriftOptions
descriptionOptions for configuring loading Thrift serialized data.
idThriftOptions
properties
boundaryBytes
descriptionOptional. Sequence of bytes used to separate two serialized Thrift data blocks. When it's used with `framing_option`, the `boundary_bytes` are expected to be in front of the framed block.
formatbyte
typestring
deserializationOption
descriptionOptional. `deserialization_option` sets how the serialized Thrift should be deserialized. The following options are supported: * THRIFT_BINARY_PROTOCOL_OPTION: using TBinaryProtocol to deserialize the data.
enum
  • DESERIALIZATION_OPTION_UNSPECIFIED
  • THRIFT_BINARY_PROTOCOL_OPTION
enumDescriptions
  • Default value. This value is unused.
  • Use `TBinaryProtocol` to deserialize the data..
typestring
framingOption
descriptionOptional. Framing in Thrift means 4 bytes slipped in front of the serialized record or data block to inidicate the size of the followed record or data block. The following options are support: * NOT_FRAMED: Serialized Thrift records or data blocks are not framed, there are no 4-byte record size in front of the record. * FRAMED_WITH_BIG_ENDIAN: Serialized Thrift records or data blocks are framed with the 4-byte record size in big endian. * FRAMED_WITH_LITTLE_ENDIAN: Serialized Thrift records or data blocks are framed with the 4-byte record size in little endian. One option to frame Thrift record at serialization time is using `TFramedTransport`, which writes the 4-byte record or data block size in big endian. By default `framing_option` is set to "NOT_FRAMED".
enum
  • FRAMING_OPTION_UNSPECIFIED
  • NOT_FRAMED
  • FRAMED_WITH_BIG_ENDIAN
  • FRAMED_WITH_LITTLE_ENDIAN
enumDescriptions
  • Default value. This value is unused.
  • Records or data blocks are not framed.
  • Records or data blocks are framed with a 4-byte record size in big endian.
  • Records or data blocks are framed with a 4-byte record size in little endian.
typestring
schemaIdlRootDir
descriptionRequired. The root directory of the IDL file bundle defining the schema. All IDL files that are used to parse the schema should be in this directory. This directory should be different from the source_uris.
typestring
schemaIdlUri
descriptionRequired. The Thrift IDL file in the `schema_idl_root_dir` that should be used as the root file to parse the schema. All included idl files in the `schema_idl_uri` should also be in the `schema_idl_root_dir` or its sub-directory.
typestring
schemaStruct
descriptionRequired. The root struct specified in `schema_idl_uri` that should be used to parse the schema.
typestring
typeobject
TimeBasedSchedule
descriptionOptions customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.
idTimeBasedSchedule
properties
endTime
descriptionDefines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment.
formatgoogle-datetime
typestring
schedule
descriptionData transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
typestring
scheduleOnce
descriptionSpecifies whether the transfer config is scheduled to only run once and remains as an internal field.
typeboolean
startTime
descriptionSpecifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment.
formatgoogle-datetime
typestring
typeobject
TimePartitioning
idTimePartitioning
properties
expirationMs
descriptionOptional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value.
formatint64
typestring
field
descriptionOptional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value.
typestring
requirePartitionFilter
defaultfalse
deprecatedTrue
descriptionIf set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it.
typeboolean
type
descriptionRequired. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
typestring
typeobject
TimeRange
descriptionA specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).
idTimeRange
properties
endTime
descriptionEnd time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
formatgoogle-datetime
typestring
startTime
descriptionStart time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
formatgoogle-datetime
typestring
typeobject
TransferConfig
descriptionRepresents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
idTransferConfig
properties
callerOwned
descriptionOutput only. Returns True if the caller is the owner of this TransferConfig. This will not be populated if `dataSourceId` is 'youtube_channel'.
readOnlyTrue
typeboolean
createTime
descriptionOutput only. Creation time of the transfer config.
formatgoogle-datetime
readOnlyTrue
typestring
dataRefreshWindowDays
descriptionThe number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
formatint32
typeinteger
dataSourceId
descriptionData source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
typestring
datasetRegion
descriptionOutput only. Region in which BigQuery dataset is located.
readOnlyTrue
typestring
destinationDataset
$refDatasetReference
descriptionThe BigQuery target dataset.
destinationDatasetId
descriptionThe BigQuery target dataset id.
typestring
disabled
descriptionIs this config disabled. When set to true, no runs will be scheduled for this transfer config.
typeboolean
displayName
descriptionUser specified display name for the data transfer.
typestring
emailPreferences
$refEmailPreferences
descriptionEmail notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
encryptionConfiguration
$refEncryptionConfiguration
descriptionThe encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
error
$refStatus
descriptionOutput only. Error code with detailed information about reason of the latest config failure.
readOnlyTrue
manualRunScheduleType
descriptionOutput only. The manual run scheduling option used by UI.
enum
  • MANUAL_RUN_SCHEDULE_TYPE_UNSPECIFIED
  • MANUAL_RUN_DISABLED
  • SCHEDULE_BACKFILL
  • REFRESH_TRANSFER
  • REFRESH_PROJECTION
enumDescriptions
  • Type unspecified
  • Do not allow schedule manual runs
  • Schedule transfer runs by showing a date range picker
  • Simply refresh the transfer without a run date
  • Refresh the Projection transfer without a run date
readOnlyTrue
typestring
name
descriptionIdentifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
typestring
nextRunTime
descriptionOutput only. Next time when data transfer will run.
formatgoogle-datetime
readOnlyTrue
typestring
nextScheduleTime
descriptionOutput only. Next schedule_time for automatically created transfer runs of this config. Will not be set if config is disabled.
formatgoogle-datetime
readOnlyTrue
typestring
notificationPubsubTopic
descriptionPub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
typestring
originalAuthority
descriptionOutput only. OriginalAuthority of the user who created or updated the config. This will be used for auto-scheduled Transfer Runs. The security credentials library recommends storing this message as a blob. cs/symbol:security.credentials.OriginalAuthority
formatbyte
readOnlyTrue
typestring
ownerInfo
$refUserInfo
descriptionOutput only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
readOnlyTrue
params
additionalProperties
descriptionProperties of the object.
typeany
descriptionParameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
typeobject
partnerConnectionInfo
additionalProperties
descriptionProperties of the object.
typeany
descriptionTransfer settings managed by partner data sources. It is stored as key-value pairs and used for DTS UI display purpose only. Two reasons we don't want to store them together with 'params' are: - The connection info is provided by partner and not editable in DTS UI which is different from the immutable parameter. It will be confusing to add another boolean to DataSourceParameter to differentiate them. - The connection info can be any arbitrary key-value pairs. Adding them to params fields requires partner to provide definition for them in data source definition. It will be friendlier to avoid that for partners.
typeobject
partnerToken
descriptionA unique identifier used for identifying a transfer setup stored on external partner side. The token is opaque to DTS and can only be interpreted by partner. Partner data source should create a mapping between the config id and the token to validate that a transfer config/run is legitimate.
typestring
schedule
descriptionData transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
typestring
scheduleOptions
$refScheduleOptions
descriptionOptions customizing the data transfer schedule.
scheduleOptionsV2
$refScheduleOptionsV2
descriptionOptions customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
state
descriptionOutput only. State of the most recently updated transfer run.
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
readOnlyTrue
typestring
tableFilters
descriptionTables that need to be loaded. If it's empty, then all tables will be loaded. Case insensitive.
items
typestring
typearray
updateTime
descriptionOutput only. Data transfer modification time. Ignored by server on input.
formatgoogle-datetime
readOnlyTrue
typestring
userId
descriptionDeprecated. Unique ID of the user on whose behalf transfer is done.
formatint64
typestring
typeobject
TransferMessage
descriptionRepresents a user facing message for a particular data transfer run.
idTransferMessage
properties
messageText
descriptionMessage text.
typestring
messageTime
descriptionTime when message was logged.
formatgoogle-datetime
typestring
severity
descriptionMessage severity.
enum
  • MESSAGE_SEVERITY_UNSPECIFIED
  • INFO
  • WARNING
  • ERROR
  • DEBUG
enumDescriptions
  • No severity specified.
  • Informational message.
  • Warning message.
  • Error message.
  • Debug message.
typestring
typeobject
TransferRun
descriptionRepresents a data transfer run.
idTransferRun
properties
cause
descriptionOutput only. Describes the cause for the transfer run creation. This value should not change after the transfer run is created.
enum
  • TRANSFER_CAUSE_UNSPECIFIED
  • RETRY_BY_DATA_SOURCE
  • USER_REQUEST
  • AUTO_SCHEDULE
  • AUTO_SCHEDULE_REFRESH
  • EVENT_DRIVEN
enumDescriptions
  • Cause placeholder.
  • Created for retry.
  • Requested by user.
  • Automatically scheduled.
  • Automatically scheduled for backfill. This is set when 1. a data source defines default_data_refresh_window_days > 1 2. and the auto-scheduled transfer run is for a date in the past.
  • Initiated by event-driven transfer.
readOnlyTrue
typestring
dataSourceId
descriptionOutput only. Data source id.
readOnlyTrue
typestring
dataVersion
descriptionFor data sources that support continuous data refresh, the latest data version that has been loaded. Newer data must have greater (using string compare) data_version (e.g. timestamp in YYYYMMDD HH:MM:SS format).
typestring
datasetRegion
descriptionOutput only. Region in which BigQuery dataset is located.
readOnlyTrue
typestring
destinationDataset
$refDatasetReference
descriptionOutput only. The BigQuery target destination.
readOnlyTrue
destinationDatasetId
descriptionOutput only. The BigQuery target dataset id.
readOnlyTrue
typestring
emailPreferences
$refEmailPreferences
descriptionOutput only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
readOnlyTrue
encryptionConfiguration
$refEncryptionConfiguration
descriptionThe encryption configuration applied to the transfer run.
endTime
descriptionOutput only. Time when transfer run ended. Parameter ignored by server for input requests.
formatgoogle-datetime
readOnlyTrue
typestring
errorStatus
$refStatus
descriptionStatus of the transfer run.
experimentInfo
$refExperimentInfo
descriptionMendel experiment info for the transfer run.
labels
additionalProperties
typestring
descriptionUser labels.
typeobject
name
descriptionIdentifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
typestring
notificationPubsubTopic
descriptionOutput only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
readOnlyTrue
typestring
originalAuthority
descriptionOutput only. OriginalAuthority of the user who created or updated the config. This will be used for auto-scheduled Transfer Runs. The security credentials library recommends storing this message as a blob. cs/symbol:security.credentials.OriginalAuthority
formatbyte
readOnlyTrue
typestring
params
additionalProperties
descriptionProperties of the object.
typeany
descriptionOutput only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
readOnlyTrue
typeobject
partnerToken
descriptionOutput only. This is the same token initialized from TransferConfig. Partner token is a unique identifier used for identifying a transfer setup stored on external partner side. The token is opaque to DTS and can only be interpreted by partner. Partner data source should create a mapping between the config id and the token to validate that a transfer config/run is legitimate.
readOnlyTrue
typestring
runTime
descriptionFor batch transfer runs, specifies the date and time of the data should be ingested.
formatgoogle-datetime
typestring
schedule
descriptionOutput only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this.
readOnlyTrue
typestring
scheduleTime
descriptionMinimum time after which a transfer run can be started.
formatgoogle-datetime
typestring
startTime
descriptionOutput only. Time when transfer run was started. Parameter ignored by server for input requests.
formatgoogle-datetime
readOnlyTrue
typestring
state
descriptionData transfer run state. Ignored for input requests.
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
typestring
subtaskOverallState
descriptionOverall state of subtasks belonging to the run. UNSPECIFIED means the transfer run doesn't have any subtask, SUCCEEDED means all subtasks succeeded, RUNNING means some subtasks are still running, and FAILED means some subtasks failed. Currently this should only be set when all the subtasks get into terminate state.
enum
  • STATE_UNSPECIFIED
  • RUNNING
  • SUCCEEDED
  • FAILED
enumDescriptions
  • Invalid or unspecified state.
  • Subtask is running.
  • Subtask succeeded.
  • Subtask failed.
typestring
tableFilters
descriptionTables that need to be loaded. If it's empty, then all tables will be loaded. Case insensitive.
items
typestring
typearray
updateTime
descriptionOutput only. Last time the data transfer run state was updated.
formatgoogle-datetime
readOnlyTrue
typestring
userId
descriptionDeprecated. Unique ID of the user on whose behalf transfer is done.
formatint64
typestring
typeobject
TransferRunBillingMeasurementEntry
descriptionA single measurement entry of resource usage for a transfer run.
idTransferRunBillingMeasurementEntry
properties
cloudNatBytes
descriptionRequired. volume of data processed by cloud nat this will be 0 if PSC Network Attachment was used
formatint64
typestring
cloudNatDuration
descriptionRequired. time spent using cloud NAT this will be 0 if PSC Network Attachment was used in nanoseconds
formatgoogle-duration
typestring
dts3pBorgDuration
descriptionRequired. transfer run execution time spent using DTS3P borg in nanoseconds
formatgoogle-duration
typestring
endTime
descriptionRequired. time at which billing measurements capture ended
formatgoogle-datetime
typestring
gcsBytes
descriptionRequired. volume of data stored in Cloud Storage for staging
formatint64
typestring
id
descriptionRequired. ID of the entry for deduplication
typestring
startTime
descriptionRequired. time at which billing measurements capture started
formatgoogle-datetime
typestring
ucsBorgDuration
descriptionRequired. transfer run execution time spent using UCS borg in nanoseconds
formatgoogle-duration
typestring
ucsGceDuration
descriptionRequired. transfer run execution time spent using Compute Engine VM in nanoseconds
formatgoogle-duration
typestring
typeobject
TransferRunSummary
descriptionSummary of the status of jobs started by a given run.
idTransferRunSummary
properties
bigqueryJobsCounts
$refJobCounts
descriptionThe counts for BigQuery jobs.
typeobject
TransferSubtask
descriptionRepresents a subtask for a particular data transfer run.
idTransferSubtask
properties
createTime
descriptionOutput only. The creation time for the subtask.
formatgoogle-datetime
readOnlyTrue
typestring
dataSourceId
descriptionOutput only. Data source id.
readOnlyTrue
typestring
dataVersion
descriptionData version for the subtask, which is interpreted by data source. Cannot be updated after creation.
typestring
datasetRegion
descriptionOutput only. Region in which BigQuery dataset is located.
readOnlyTrue
typestring
errorStatus
$refStatus
descriptionError code with more detailed information about reason of subtask failure. One of the values of google.rpc.Code enum: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto This value is set only after subtask is in one of the finalized states: SUCCEEDED or FAILED.
experiments
descriptionMendel experiment flags read by transfer run and passed to subtasks.
items
typestring
typearray
name
descriptionThe resource name of the transfer run subtask. The names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}/subtasks/{subtask_id}`. The name is ignored when creating a subtask.
typestring
originalAuthority
descriptionOutput only. OriginalAuthority of the user who created or updated the config. This will be used for auto-scheduled Transfer Runs. The security credentials library recommends storing this message as a blob. cs/symbol:security.credentials.OriginalAuthority
formatbyte
readOnlyTrue
typestring
retriable
descriptionSet to true if this subtask should be requeued to retry.
typeboolean
retryCount
descriptionNumber of previous retries processing this subtask.
formatint64
typestring
retryDelay
descriptionDelay for the retry.
formatgoogle-duration
typestring
runScheduleTime
descriptionOutput only. The schedule_time for the parent transfer run.
formatgoogle-datetime
readOnlyTrue
typestring
runTime
descriptionOutput only. The date and time that data should be ingested for the parent transfer run.
formatgoogle-datetime
readOnlyTrue
typestring
state
descriptionState of the subtask, which is updated by data sources.
enum
  • STATE_UNSPECIFIED
  • RUNNING
  • SUCCEEDED
  • FAILED
enumDescriptions
  • Invalid or unspecified state.
  • Subtask is running.
  • Subtask succeeded.
  • Subtask failed.
typestring
subtaskInfo
additionalProperties
descriptionProperties of the object.
typeany
descriptionThe details of the subtask, which is interpreted by data source only. For now task_info will be ignored when updating.
typeobject
subtaskResult
additionalProperties
descriptionProperties of the object.
typeany
descriptionResult of subtask, which is updated and interpreted by data source only.
typeobject
updateTime
descriptionOutput only. The modification time for the subtask.
formatgoogle-datetime
readOnlyTrue
typestring
userId
descriptionOutput only. The user id for this transfer run.
formatint64
readOnlyTrue
typestring
typeobject
TypeParameters
descriptionType Parameters for NUMERIC, STRING or BYTES types For NUMERIC types - Precision and Scale can be provided For STRING or BYTES - Max Length can be provided
idTypeParameters
properties
maxLength
descriptionIndicates the maximum length of string or bytes values
formatint64
typestring
precision
descriptionIndicates the precision of decimal values
formatint64
typestring
scale
descriptionIndicates the scale of decimal values
formatint64
typestring
typeobject
UnenrollDataSourcesRequest
descriptionA request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's `Transfer` tab.
idUnenrollDataSourcesRequest
properties
dataSourceIds
descriptionData sources that are unenrolled. It is required to provide at least one data source id.
items
typestring
typearray
typeobject
UserInfo
descriptionInformation about a user.
idUserInfo
properties
email
descriptionE-mail address of the user.
typestring
typeobject
ViewInfo
descriptionView creation/update related info.
idViewInfo
properties
skipCreateOrUpdateView
descriptionSkip creating or updating the view.
typeboolean
view
descriptionName of the view.
typestring
viewQuery
descriptionQuery used to create or update the view.
typestring
typeobject
iterable_item_removed
root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['resources']['runs']['resources']['transferLogs']['methods']['list']['parameters']['messageTypes']['enum'][4]DEBUG
root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['resources']['runs']['resources']['transferLogs']['methods']['list']['parameters']['messageTypes']['enumDescriptions'][4]Debug message.
root['resources']['projects']['resources']['transferConfigs']['resources']['runs']['resources']['transferLogs']['methods']['list']['parameters']['messageTypes']['enum'][4]DEBUG
root['resources']['projects']['resources']['transferConfigs']['resources']['runs']['resources']['transferLogs']['methods']['list']['parameters']['messageTypes']['enumDescriptions'][4]Debug message.
sandbox/test-bigquerydatatransfer-v1
dictionary_item_removed
  • root['resources']['projects']['methods']['isEnabled']
  • root['resources']['projects']['methods']['setEnabled']
  • root['resources']['projects']['resources']['locations']['methods']['enableDataTransferService']
  • root['resources']['projects']['resources']['locations']['methods']['isDataTransferServiceEnabled']
  • root['resources']['projects']['resources']['locations']['methods']['setEnabled']
  • root['resources']['projects']['resources']['locations']['methods']['list']['parameters']['includeUnrevealedLocations']
  • root['resources']['projects']['resources']['locations']['resources']['dataSourceDefinitions']
  • root['resources']['projects']['resources']['locations']['resources']['dtsTenantProject']
  • root['resources']['projects']['resources']['locations']['resources']['dtsTenantProjects']
  • root['resources']['projects']['resources']['locations']['resources']['experiments']
  • root['resources']['projects']['resources']['locations']['resources']['dataSources']['resources']
  • root['resources']['projects']['resources']['locations']['resources']['dataSources']['methods']['browse']
  • root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['methods']['log3pTosAccepted']
  • root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['methods']['partition']
  • root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['methods']['stream']
  • root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['methods']['create']['parameters']['transferConfigId']
  • root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['resources']['-']
  • root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['resources']['runs']['resources']['subtasks']
  • root['resources']['projects']['resources']['transferConfigs']['methods']['create']['parameters']['transferConfigId']
  • root['resources']['projects']['resources']['transferConfigs']['resources']['runs']['methods']['cancel']
  • root['resources']['projects']['resources']['transferConfigs']['resources']['runs']['methods']['create']
values_changed
root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['resources']['runs']['methods']
new_value
delete
descriptionDeletes the specified transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
httpMethodDELETE
idbigquerydatatransfer.projects.locations.transferConfigs.runs.delete
parameterOrder
  • name
parameters
name
descriptionRequired. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionReturns information about the particular transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
httpMethodGET
idbigquerydatatransfer.projects.locations.transferConfigs.runs.get
parameterOrder
  • name
parameters
name
descriptionRequired. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refTransferRun
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
list
descriptionReturns information about running and completed transfer runs.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs
httpMethodGET
idbigquerydatatransfer.projects.locations.transferConfigs.runs.list
parameterOrder
  • parent
parameters
pageSize
descriptionPage size. The default page size is the maximum value of 1000 results.
formatint32
locationquery
typeinteger
pageToken
descriptionPagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
locationquery
typestring
parent
descriptionRequired. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
requiredTrue
typestring
runAttempt
descriptionIndicates how run attempts are to be pulled.
enum
  • RUN_ATTEMPT_UNSPECIFIED
  • LATEST
enumDescriptions
  • All runs should be returned.
  • Only latest run per day should be returned.
locationquery
typestring
states
descriptionWhen specified, only transfer runs with requested states are returned.
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
locationquery
repeatedTrue
typestring
pathv1/{+parent}/runs
response
$refListTransferRunsResponse
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
old_value
cancel
descriptionCancels a data transfer run. Marks run as cancelled. It is up to the data source to decide at which point the transfer run is cancelled. Only supported for batch data sources. Unlike delete, it retains the transfer run and just sets the transfer run state to CANCELLED, so that data source can stop ingesting data (if that is possible).
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:cancel
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.cancel
parameterOrder
  • name
parameters
name
descriptionRequired. The field will contain the name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`.
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:cancel
request
$refCancelTransferRunRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
create
descriptionCreates a single transfer run for this data transfer. Only supported for batch data sources.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.create
parameterOrder
  • parent
parameters
parent
descriptionTransfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or . `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
requiredTrue
typestring
pathv1/{+parent}/runs
request
$refTransferRun
response
$refTransferRun
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
delete
descriptionDeletes the specified transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
httpMethodDELETE
idbigquerydatatransfer.projects.locations.transferConfigs.runs.delete
parameterOrder
  • name
parameters
name
descriptionRequired. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
finishRun
descriptionNotify the Data Transfer Service that the data source is done processing the run. No more status updates or requests to start/monitor jobs will be accepted. The run will be finalized by the Data Transfer Service when all monitored jobs are completed. Does not need to be called if the run is set to FAILED.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:finishRun
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.finishRun
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:finishRun
request
$refFinishRunRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
get
descriptionReturns information about the particular transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
httpMethodGET
idbigquerydatatransfer.projects.locations.transferConfigs.runs.get
parameterOrder
  • name
parameters
name
descriptionRequired. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}
response
$refTransferRun
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
getInternal
descriptionReturns information about the specified transfer run. This API is for internal clients and will not be exposed to external customers. Caller needs to be internally allow-listed, or have `bigquery.datasources.update` permission to call this API.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:getInternal
httpMethodGET
idbigquerydatatransfer.projects.locations.transferConfigs.runs.getInternal
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the transfer run in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:getInternal
response
$refTransferRun
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
getRunSummary
descriptionRetrieves summary of jobs that were started by the given transfer run. Note that a stale read against the database is performed with 10 seconds staleness. It is important that this only summarizes the jobs that were created as of the database read timestamp. It is possible that the transfer run is not finalized and more jobs will be created. Can be used to let the data source wait for jobs to finish before continuing other work.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/runSummary
httpMethodGET
idbigquerydatatransfer.projects.locations.transferConfigs.runs.getRunSummary
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the transfer run in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}/runSummary
response
$refTransferRunSummary
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
list
descriptionReturns information about running and completed transfer runs.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs
httpMethodGET
idbigquerydatatransfer.projects.locations.transferConfigs.runs.list
parameterOrder
  • parent
parameters
pageSize
descriptionPage size. The default page size is the maximum value of 1000 results.
formatint32
locationquery
typeinteger
pageToken
descriptionPagination token, which can be used to request a specific page of `ListTransferRunsRequest` list results. For multiple-page results, `ListTransferRunsResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.
locationquery
typestring
parent
descriptionRequired. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$
requiredTrue
typestring
runAttempt
descriptionIndicates how run attempts are to be pulled.
enum
  • RUN_ATTEMPT_UNSPECIFIED
  • LATEST
enumDescriptions
  • All runs should be returned.
  • Only latest run per day should be returned.
locationquery
typestring
states
descriptionWhen specified, only transfer runs with requested states are returned.
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
locationquery
repeatedTrue
typestring
pathv1/{+parent}/runs
response
$refListTransferRunsResponse
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
logMessages
descriptionLog messages for a transfer run. If successful (at least 1 message), resets data_source.update_deadline_seconds timer.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:logMessages
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.logMessages
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:logMessages
request
$refLogTransferRunMessagesRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
monitorBigQueryJobs
descriptionNotify the Data Transfer Service that the following BigQuery jobs should be monitored. Monitored jobs will be automatically retried and produce log messages when starting and finishing a job. Used when a data source initiates multiple BigQuery jobs outside of StartBigQueryJobs. Can be called multiple times for the same transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:monitorBigQueryJobs
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.monitorBigQueryJobs
parameterOrder
  • name
parameters
name
descriptionName of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:monitorBigQueryJobs
request
$refMonitorBigQueryJobsRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
patch
descriptionUpdate a transfer run. If successful, resets data_source.update_deadline_seconds timer.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}
httpMethodPATCH
idbigquerydatatransfer.projects.locations.transferConfigs.runs.patch
parameterOrder
  • name
parameters
name
descriptionIdentifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
updateMask
descriptionRequired list of fields to be updated in this request.
formatgoogle-fieldmask
locationquery
typestring
pathv1/{+name}
request
$refTransferRun
response
$refTransferRun
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
recordBillingMeasurement
descriptionRecord a billing measurement entry to a transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:recordBillingMeasurement
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.recordBillingMeasurement
parameterOrder
  • name
parameters
name
descriptionRequired. The name of the transfer run to record billing measurement for. Format: `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:recordBillingMeasurement
request
$refRecordTransferRunBillingMeasurementRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
startBigQueryJobs
descriptionNotify the Data Transfer Service that data is ready for loading. The Data Transfer Service will start and monitor multiple BigQuery Load jobs for a transfer run. Monitored jobs will be automatically retried and produce log messages when starting and finishing a job. Can be called multiple times for the same transfer run.
flatPathv1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}:startBigQueryJobs
httpMethodPOST
idbigquerydatatransfer.projects.locations.transferConfigs.runs.startBigQueryJobs
parameterOrder
  • name
parameters
name
descriptionRequired. Name of the resource in the form: "projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}"
locationpath
pattern^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$
requiredTrue
typestring
pathv1/{+name}:startBigQueryJobs
request
$refStartBigQueryJobsRequest
response
$refEmpty
scopes
  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform
root['revision']
new_value20250220
old_value20250218
root['schemas']
new_value
CheckValidCredsRequest
descriptionA request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.
idCheckValidCredsRequest
properties
typeobject
CheckValidCredsResponse
descriptionA response indicating whether the credentials exist and are valid.
idCheckValidCredsResponse
properties
hasValidCreds
descriptionIf set to `true`, the credentials exist and are valid.
typeboolean
typeobject
DataSource
descriptionDefines the properties and custom parameters for a data source.
idDataSource
properties
authorizationType
descriptionIndicates the type of authorization.
enum
  • AUTHORIZATION_TYPE_UNSPECIFIED
  • AUTHORIZATION_CODE
  • GOOGLE_PLUS_AUTHORIZATION_CODE
  • FIRST_PARTY_OAUTH
enumDescriptions
  • Type unspecified.
  • Use OAuth 2 authorization codes that can be exchanged for a refresh token on the backend.
  • Return an authorization code for a given Google+ page that can then be exchanged for a refresh token on the backend.
  • Use First Party OAuth.
typestring
clientId
descriptionData source client id which should be used to receive refresh token.
typestring
dataRefreshType
descriptionSpecifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.
enum
  • DATA_REFRESH_TYPE_UNSPECIFIED
  • SLIDING_WINDOW
  • CUSTOM_SLIDING_WINDOW
enumDescriptions
  • The data source won't support data auto refresh, which is default value.
  • The data source supports data auto refresh, and runs will be scheduled for the past few days. Does not allow custom values to be set for each transfer config.
  • The data source supports data auto refresh, and runs will be scheduled for the past few days. Allows custom values to be set for each transfer config.
typestring
dataSourceId
descriptionData source id.
typestring
defaultDataRefreshWindowDays
descriptionDefault data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
formatint32
typeinteger
defaultSchedule
descriptionDefault data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`.
typestring
description
descriptionUser friendly data source description string.
typestring
displayName
descriptionUser friendly data source name.
typestring
helpUrl
descriptionUrl for the help document for this data source.
typestring
manualRunsDisabled
descriptionDisables backfilling and manual run scheduling for the data source.
typeboolean
minimumScheduleInterval
descriptionThe minimum interval for scheduler to schedule runs.
formatgoogle-duration
typestring
name
descriptionOutput only. Data source resource name.
readOnlyTrue
typestring
parameters
descriptionData source parameters.
items
$refDataSourceParameter
typearray
scopes
descriptionApi auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
items
typestring
typearray
supportsCustomSchedule
descriptionSpecifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule.
typeboolean
supportsMultipleTransfers
deprecatedTrue
descriptionDeprecated. This field has no effect.
typeboolean
transferType
deprecatedTrue
descriptionDeprecated. This field has no effect.
enum
  • TRANSFER_TYPE_UNSPECIFIED
  • BATCH
  • STREAMING
enumDescriptions
  • Invalid or Unknown transfer type placeholder.
  • Batch data transfer.
  • Streaming data transfer. Streaming data source currently doesn't support multiple transfer configs per project.
typestring
updateDeadlineSeconds
descriptionThe number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
formatint32
typeinteger
typeobject
DataSourceParameter
descriptionA parameter used to define custom fields in a data source definition.
idDataSourceParameter
properties
allowedValues
descriptionAll possible values for the parameter.
items
typestring
typearray
deprecated
descriptionIf true, it should not be used in new transfers, and it should not be visible to users.
typeboolean
description
descriptionParameter description.
typestring
displayName
descriptionParameter display name in the user interface.
typestring
fields
descriptionDeprecated. This field has no effect.
items
$refDataSourceParameter
typearray
immutable
descriptionCannot be changed after initial creation.
typeboolean
maxValue
descriptionFor integer and double values specifies maximum allowed value.
formatdouble
typenumber
minValue
descriptionFor integer and double values specifies minimum allowed value.
formatdouble
typenumber
paramId
descriptionParameter identifier.
typestring
recurse
descriptionDeprecated. This field has no effect.
typeboolean
repeated
descriptionDeprecated. This field has no effect.
typeboolean
required
descriptionIs parameter required.
typeboolean
type
descriptionParameter type.
enum
  • TYPE_UNSPECIFIED
  • STRING
  • INTEGER
  • DOUBLE
  • BOOLEAN
  • RECORD
  • PLUS_PAGE
  • LIST
enumDescriptions
  • Type unspecified.
  • String parameter.
  • Integer parameter (64-bits). Will be serialized to json as string.
  • Double precision floating point parameter.
  • Boolean parameter.
  • Deprecated. This field has no effect.
  • Page ID for a Google+ Page.
  • List of strings parameter.
typestring
validationDescription
descriptionDescription of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
typestring
validationHelpUrl
descriptionURL to a help document to further explain the naming requirements.
typestring
validationRegex
descriptionRegular expression which can be used for parameter validation.
typestring
typeobject
EmailPreferences
descriptionRepresents preferences for sending email notifications for transfer run events.
idEmailPreferences
properties
enableFailureEmail
descriptionIf true, email notifications will be sent on transfer run failures.
typeboolean
typeobject
Empty
descriptionA 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); }
idEmpty
properties
typeobject
EncryptionConfiguration
descriptionRepresents the encryption configuration for a transfer.
idEncryptionConfiguration
properties
kmsKeyName
descriptionThe name of the KMS key used for encrypting BigQuery data.
typestring
typeobject
EnrollDataSourcesRequest
descriptionA request to enroll a set of data sources so they are visible in the BigQuery UI's `Transfer` tab.
idEnrollDataSourcesRequest
properties
dataSourceIds
descriptionData sources that are enrolled. It is required to provide at least one data source id.
items
typestring
typearray
typeobject
EventDrivenSchedule
descriptionOptions customizing EventDriven transfers schedule.
idEventDrivenSchedule
properties
pubsubSubscription
descriptionPub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project}/subscriptions/{subscription}
typestring
typeobject
ListDataSourcesResponse
descriptionReturns list of supported data sources and their metadata.
idListDataSourcesResponse
properties
dataSources
descriptionList of supported data sources and their transfer settings.
items
$refDataSource
typearray
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourcesRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
typeobject
ListLocationsResponse
descriptionThe response message for Locations.ListLocations.
idListLocationsResponse
properties
locations
descriptionA list of locations that matches the specified filter in the request.
items
$refLocation
typearray
nextPageToken
descriptionThe standard List next-page token.
typestring
typeobject
ListTransferConfigsResponse
descriptionThe returned list of pipelines in the project.
idListTransferConfigsResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
transferConfigs
descriptionOutput only. The stored pipeline transfer configurations.
items
$refTransferConfig
readOnlyTrue
typearray
typeobject
ListTransferLogsResponse
descriptionThe returned list transfer run messages.
idListTransferLogsResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `GetTransferRunLogRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
transferMessages
descriptionOutput only. The stored pipeline transfer messages.
items
$refTransferMessage
readOnlyTrue
typearray
typeobject
ListTransferRunsResponse
descriptionThe returned list of pipelines in the project.
idListTransferRunsResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
transferRuns
descriptionOutput only. The stored pipeline transfer runs.
items
$refTransferRun
readOnlyTrue
typearray
typeobject
Location
descriptionA resource that represents a Google Cloud location.
idLocation
properties
displayName
descriptionThe friendly name for this location, typically a nearby city name. For example, "Tokyo".
typestring
labels
additionalProperties
typestring
descriptionCross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
typeobject
locationId
descriptionThe canonical id for this location. For example: `"us-east1"`.
typestring
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata. For example the available capacity at the given location.
typeobject
name
descriptionResource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
typestring
typeobject
ManualSchedule
descriptionOptions customizing manual transfers schedule.
idManualSchedule
properties
typeobject
ScheduleOptions
descriptionOptions customizing the data transfer schedule.
idScheduleOptions
properties
disableAutoScheduling
descriptionIf true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
typeboolean
endTime
descriptionDefines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.
formatgoogle-datetime
typestring
startTime
descriptionSpecifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.
formatgoogle-datetime
typestring
typeobject
ScheduleOptionsV2
descriptionV2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
idScheduleOptionsV2
properties
eventDrivenSchedule
$refEventDrivenSchedule
descriptionEvent driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.
manualSchedule
$refManualSchedule
descriptionManual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.
timeBasedSchedule
$refTimeBasedSchedule
descriptionTime based transfer schedule options. This is the default schedule option.
typeobject
ScheduleTransferRunsRequest
descriptionA request to schedule transfer runs for a time range.
idScheduleTransferRunsRequest
properties
endTime
descriptionRequired. End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`.
formatgoogle-datetime
typestring
startTime
descriptionRequired. Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`.
formatgoogle-datetime
typestring
typeobject
ScheduleTransferRunsResponse
descriptionA response to schedule transfer runs for a time range.
idScheduleTransferRunsResponse
properties
runs
descriptionThe transfer runs that were scheduled.
items
$refTransferRun
typearray
typeobject
StartManualTransferRunsRequest
descriptionA request to start manual transfer runs.
idStartManualTransferRunsRequest
properties
requestedRunTime
descriptionA run_time timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_run_time must be a past time and cannot include future time values.
formatgoogle-datetime
typestring
requestedTimeRange
$refTimeRange
descriptionA time_range start and end timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_time_range must be a past time and cannot include future time values.
typeobject
StartManualTransferRunsResponse
descriptionA response to start manual transfer runs.
idStartManualTransferRunsResponse
properties
runs
descriptionThe transfer runs that were created.
items
$refTransferRun
typearray
typeobject
Status
descriptionThe `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).
idStatus
properties
code
descriptionThe status code, which should be an enum value of google.rpc.Code.
formatint32
typeinteger
details
descriptionA list of messages that carry the error details. There is a common set of message types for APIs to use.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
message
descriptionA 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.
typestring
typeobject
TimeBasedSchedule
descriptionOptions customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.
idTimeBasedSchedule
properties
endTime
descriptionDefines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment.
formatgoogle-datetime
typestring
schedule
descriptionData transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
typestring
startTime
descriptionSpecifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment.
formatgoogle-datetime
typestring
typeobject
TimeRange
descriptionA specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).
idTimeRange
properties
endTime
descriptionEnd time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
formatgoogle-datetime
typestring
startTime
descriptionStart time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
formatgoogle-datetime
typestring
typeobject
TransferConfig
descriptionRepresents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
idTransferConfig
properties
dataRefreshWindowDays
descriptionThe number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
formatint32
typeinteger
dataSourceId
descriptionData source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
typestring
datasetRegion
descriptionOutput only. Region in which BigQuery dataset is located.
readOnlyTrue
typestring
destinationDatasetId
descriptionThe BigQuery target dataset id.
typestring
disabled
descriptionIs this config disabled. When set to true, no runs will be scheduled for this transfer config.
typeboolean
displayName
descriptionUser specified display name for the data transfer.
typestring
emailPreferences
$refEmailPreferences
descriptionEmail notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
encryptionConfiguration
$refEncryptionConfiguration
descriptionThe encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
error
$refStatus
descriptionOutput only. Error code with detailed information about reason of the latest config failure.
readOnlyTrue
name
descriptionIdentifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
typestring
nextRunTime
descriptionOutput only. Next time when data transfer will run.
formatgoogle-datetime
readOnlyTrue
typestring
notificationPubsubTopic
descriptionPub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
typestring
ownerInfo
$refUserInfo
descriptionOutput only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
readOnlyTrue
params
additionalProperties
descriptionProperties of the object.
typeany
descriptionParameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
typeobject
schedule
descriptionData transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
typestring
scheduleOptions
$refScheduleOptions
descriptionOptions customizing the data transfer schedule.
scheduleOptionsV2
$refScheduleOptionsV2
descriptionOptions customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
state
descriptionOutput only. State of the most recently updated transfer run.
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
readOnlyTrue
typestring
updateTime
descriptionOutput only. Data transfer modification time. Ignored by server on input.
formatgoogle-datetime
readOnlyTrue
typestring
userId
descriptionDeprecated. Unique ID of the user on whose behalf transfer is done.
formatint64
typestring
typeobject
TransferMessage
descriptionRepresents a user facing message for a particular data transfer run.
idTransferMessage
properties
messageText
descriptionMessage text.
typestring
messageTime
descriptionTime when message was logged.
formatgoogle-datetime
typestring
severity
descriptionMessage severity.
enum
  • MESSAGE_SEVERITY_UNSPECIFIED
  • INFO
  • WARNING
  • ERROR
enumDescriptions
  • No severity specified.
  • Informational message.
  • Warning message.
  • Error message.
typestring
typeobject
TransferRun
descriptionRepresents a data transfer run.
idTransferRun
properties
dataSourceId
descriptionOutput only. Data source id.
readOnlyTrue
typestring
destinationDatasetId
descriptionOutput only. The BigQuery target dataset id.
readOnlyTrue
typestring
emailPreferences
$refEmailPreferences
descriptionOutput only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
readOnlyTrue
endTime
descriptionOutput only. Time when transfer run ended. Parameter ignored by server for input requests.
formatgoogle-datetime
readOnlyTrue
typestring
errorStatus
$refStatus
descriptionStatus of the transfer run.
name
descriptionIdentifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
typestring
notificationPubsubTopic
descriptionOutput only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
readOnlyTrue
typestring
params
additionalProperties
descriptionProperties of the object.
typeany
descriptionOutput only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
readOnlyTrue
typeobject
runTime
descriptionFor batch transfer runs, specifies the date and time of the data should be ingested.
formatgoogle-datetime
typestring
schedule
descriptionOutput only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this.
readOnlyTrue
typestring
scheduleTime
descriptionMinimum time after which a transfer run can be started.
formatgoogle-datetime
typestring
startTime
descriptionOutput only. Time when transfer run was started. Parameter ignored by server for input requests.
formatgoogle-datetime
readOnlyTrue
typestring
state
descriptionData transfer run state. Ignored for input requests.
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
typestring
updateTime
descriptionOutput only. Last time the data transfer run state was updated.
formatgoogle-datetime
readOnlyTrue
typestring
userId
descriptionDeprecated. Unique ID of the user on whose behalf transfer is done.
formatint64
typestring
typeobject
UnenrollDataSourcesRequest
descriptionA request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's `Transfer` tab.
idUnenrollDataSourcesRequest
properties
dataSourceIds
descriptionData sources that are unenrolled. It is required to provide at least one data source id.
items
typestring
typearray
typeobject
UserInfo
descriptionInformation about a user.
idUserInfo
properties
email
descriptionE-mail address of the user.
typestring
typeobject
old_value
Asset
descriptionMessage for an asset in the browsing response.
idAsset
properties
asset
descriptionString that represents an asset. The client can use this string to continue to browse the data source if this asset can be browsed.
typestring
hasChild
descriptionIndicate if the asset can have child. The client can continue to browse using this asset.
typeboolean
typeobject
AvroOptions
descriptionAVRO specific options
idAvroOptions
properties
enableLogicalTypes
descriptionIf set to true will enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).
typeboolean
typeobject
BatchCreateTransferRunsRequest
descriptionRepresents request of BatchCreateTransferRuns method
idBatchCreateTransferRunsRequest
properties
transferRuns
descriptionList of TransferRuns to be scheduled. Runs can be from different data sources. All runs are committed as a single transaction, so this operation is atomic.
items
$refTransferRun
typearray
typeobject
BatchCreateTransferSubtasksRequest
descriptionRepresents request of BatchCreateTransferSubtasks method
idBatchCreateTransferSubtasksRequest
properties
dataVersion
descriptionData version of related subtasks.
typestring
hasMore
descriptionIf set to true, subsequent call can be made to append subtasks. If set to false(default), subsequent call will result in exception.
typeboolean
subtasks
descriptionList of subtasks (for one transfer run) to be scheduled. All subtasks are committed as a single transaction, so this operation is atomic. Name of the subtasks will be re-generated by backend, so the names from this fields will be ignored.
items
$refTransferSubtask
typearray
typeobject
BatchCreateTransferSubtasksResponse
descriptionRepresents response of BatchCreateTransferSubtasks method
idBatchCreateTransferSubtasksResponse
properties
subtasks
descriptionList of subtasks (for one transfer run) to be scheduled.
items
$refTransferSubtask
typearray
typeobject
BigQueryJobMonitoringInfo
descriptionContains necessary information to monitor a BigQuery job.
idBigQueryJobMonitoringInfo
properties
dataVersion
descriptionData version associated with the data the job is loading, if applicable. Used to ensure multiple jobs are not writing to the same table at the same time.
typestring
destinationTableId
descriptionDestination table of the job.
typestring
jobId
descriptionId of the BigQuery job to monitor.
typestring
typeobject
BrowseConfig
descriptionConfig for browsing assets in DTS 3P datasources.
idBrowseConfig
properties
optionalParams
descriptionOptional parameters for browsing assets - these are sent to the browse asset request if the user has entered something.
items
typestring
typearray
requiredParams
descriptionRequired parameters for browsing assets.
items
typestring
typearray
typeobject
BrowseDataSourceConfig
descriptionThis message contains all required parameters to browse a data source
idBrowseDataSourceConfig
properties
asset
descriptionParent asset for the browsing. If none is provided, start from root level.
typestring
params
additionalProperties
descriptionProperties of the object.
typeany
descriptionParams needed to access the data source.
typeobject
typeobject
BrowseDataSourceResponse
descriptionResponse of browsing a data source.
idBrowseDataSourceResponse
properties
assets
descriptionThe assets under the requested asset id
items
$refAsset
typearray
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page browsing results, this token can be used as the `BrowseDataSourceRequest.page_token` to request the next page of browsing results.
readOnlyTrue
typestring
typeobject
CancelTransferRunRequest
descriptionA request to cancel a data transfer run. Unlike delete, this method marks the transfer run state as `CANCELLED`. The transfer run itself and its logs are retained.
idCancelTransferRunRequest
properties
typeobject
CapabilityConfig
descriptionCapability config datasource specific features.
idCapabilityConfig
properties
browseConfig
$refBrowseConfig
descriptionEach config is optional and only included if the datasource is using that capability. Config for browsing assets in DTS 3P datasources
typeobject
CheckValidCredsRequest
descriptionA request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.
idCheckValidCredsRequest
properties
typeobject
CheckValidCredsResponse
descriptionA response indicating whether the credentials exist and are valid.
idCheckValidCredsResponse
properties
hasValidCreds
descriptionIf set to `true`, the credentials exist and are valid.
typeboolean
typeobject
Clustering
descriptionConfigures table clustering.
idClustering
properties
fields
descriptionOne or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. The ordering of the clustering fields should be prioritized from most to least important for filtering purposes. For additional information, see [Introduction to clustered tables](https://cloud.google.com/bigquery/docs/clustered-tables#limitations).
items
typestring
typearray
typeobject
CopyJobInfo
descriptionInformation to start a BigQuery copy job.
idCopyJobInfo
properties
copyCrossRegion
descriptionDescribe whether the copy operation is cross-region. Should only be set if copying table cross region.
typeboolean
dataVersion
descriptionData version associated with the data for this job. Used for deduplicating and ordering jobs.
typestring
destinationExpirationTime
descriptionThe time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
formatgoogle-datetime
typestring
destinationTableDescription
descriptionThe description of a destination table. This can be several sentences or paragraphs describing the table contents in detail.
typestring
destinationTableId
descriptionDestination table id. The full table reference is derived from the destination dataset defined in the transfer config and transfer run.
typestring
destinationTableKmsKey
descriptionOptional cloud KMS encryption key. When not specified default encryption is used.
typestring
jobProjectId
descriptionIf specified, jobs are billed to this project_id, rather than project_id of the TransferRun.
typestring
operationType
descriptionSupported operation types in table copy job.
enum
  • OPERATION_TYPE_UNSPECIFIED
  • COPY
  • SNAPSHOT
  • RESTORE
enumDescriptions
  • Unspecified operation type.
  • The source and destination table have the same table type.
  • The source table type is TABLE and the destination table type is SNAPSHOT.
  • The source table type is SNAPSHOT and the destination table type is TABLE.
typestring
requestedJobId
descriptionAdded for parity with ImportedDataInfo, so this field can be referenced in a shared template code.
typestring
sourceTableRef
descriptionSource table references.
items
$refTableReference
typearray
writeDisposition
descriptionSpecifies the action if the destination table already exists.
enum
  • WRITE_DISPOSITION_UNSPECIFIED
  • WRITE_TRUNCATE
  • WRITE_APPEND
  • WRITE_EMPTY
enumDescriptions
  • The default writeDispostion
  • overwrites the table data.
  • the data is appended to the table. Note duplication might happen if this mode is used.
  • This job should only be writing to empty tables.
typestring
typeobject
Credentials
descriptionCredentials for User associated with a specific data source.
idCredentials
properties
authToken
descriptionAuth token which can be used to perform requests on behalf of the user.
typestring
name
descriptionName of this credentials object in the form projects/-/locations/{location_id}/dataSources/{data_source_id}/credentials/{user_id}
typestring
typeobject
CsvOptions
descriptionCSV specific options.
idCsvOptions
properties
allowJaggedRows
descriptionAccept rows that are missing trailing optional columns.
typeboolean
allowQuotedNewlines
descriptionWhether CSV files are allowed to have quoted newlines. If quoted newlines are allowed, we can't split CSV files.
typeboolean
fieldDelimiter
descriptionThe delimiter. We currently restrict this to U+0001 to U+00FF and apply additional constraints during validation.
typestring
preserveAsciiControlCharacters
descriptionPreserve embedded Ascii Control characters.
typeboolean
quoteChar
descriptionThe quote character. We currently restrict this to U+0000 to U+00FF and apply additional constraints during validation. Set to '\0' to indicate no quote is used.
typestring
skipLeadingRows
descriptionNumber of leading rows to skip.
formatint64
typestring
typeobject
CustomScheduleGranularity
descriptionThe supported granularity of custom scheduling. Only applies if the data source supports custom scheduling.
idCustomScheduleGranularity
properties
daily
descriptionSupports daily based custom scheduling.
typeboolean
typeobject
DataSource
descriptionDefines the properties and custom parameters for a data source.
idDataSource
properties
authorizationType
descriptionIndicates the type of authorization.
enum
  • AUTHORIZATION_TYPE_UNSPECIFIED
  • AUTHORIZATION_CODE
  • GOOGLE_PLUS_AUTHORIZATION_CODE
  • FIRST_PARTY_OAUTH
enumDescriptions
  • Type unspecified.
  • Use OAuth 2 authorization codes that can be exchanged for a refresh token on the backend.
  • Return an authorization code for a given Google+ page that can then be exchanged for a refresh token on the backend.
  • Use First Party OAuth.
typestring
capabilities
descriptionCapabilities of a data source
items
enum
  • CAPABILITY_UNSPECIFIED
  • BROWSE
  • EVENT_DRIVEN_TRANSFER
enumDescriptions
  • No capabilities specified.
  • The data source supports browsing to return assets inside the given data source
  • The data source supports event driven transfer
typestring
typearray
capabilityConfig
$refCapabilityConfig
descriptionCapability config datasource specific features.
clientId
descriptionData source client id which should be used to receive refresh token.
typestring
customScheduleGranularity
$refCustomScheduleGranularity
descriptionThe supported granularity for custom schedule.
dataRefreshType
descriptionSpecifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.
enum
  • DATA_REFRESH_TYPE_UNSPECIFIED
  • SLIDING_WINDOW
  • CUSTOM_SLIDING_WINDOW
enumDescriptions
  • The data source won't support data auto refresh, which is default value.
  • The data source supports data auto refresh, and runs will be scheduled for the past few days. Does not allow custom values to be set for each transfer config.
  • The data source supports data auto refresh, and runs will be scheduled for the past few days. Allows custom values to be set for each transfer config.
typestring
dataSourceId
descriptionData source id.
typestring
defaultDataRefreshWindowDays
descriptionDefault data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.
formatint32
typeinteger
defaultSchedule
descriptionDefault data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`.
typestring
defaultScheduleOptions
$refScheduleOptions
descriptionDefault values for options customizing the data transfer schedule.
description
descriptionUser friendly data source description string.
typestring
displayName
descriptionUser friendly data source name.
typestring
helpUrl
descriptionUrl for the help document for this data source.
typestring
isInternal
descriptionOutput only. Indicates if this is an internal data source. This field is be set to true if the data source owner project is an internal project. Otherwise, it is set to false. Ignored by server on input.
readOnlyTrue
typeboolean
manualRunScheduleType
descriptionThe manual run scheduling options
enum
  • MANUAL_RUN_SCHEDULE_TYPE_UNSPECIFIED
  • MANUAL_RUN_DISABLED
  • SCHEDULE_BACKFILL
  • REFRESH_TRANSFER
  • REFRESH_PROJECTION
enumDescriptions
  • Type unspecified
  • Do not allow schedule manual runs
  • Schedule transfer runs by showing a date range picker
  • Simply refresh the transfer without a run date
  • Refresh the Projection transfer without a run date
typestring
manualRunsDisabled
descriptionDisables backfilling and manual run scheduling for the data source.
typeboolean
maximumInflightTransferRuns
descriptionMaximum inflight runs for this data source.
formatint64
typestring
minimumScheduleInterval
descriptionThe minimum interval for scheduler to schedule runs.
formatgoogle-duration
typestring
name
descriptionOutput only. Data source resource name.
readOnlyTrue
typestring
noOverlappedRuns
descriptionTransfer runs will not be processed in parallel, so there will be only one active run (pending or running) allowed for a given time.
typeboolean
parameters
descriptionData source parameters.
items
$refDataSourceParameter
typearray
partnerLegalName
descriptionPartner's legal name of this data source
typestring
redirectUrl
descriptionRedirect URL to complete transfer config setup for 3rd party data sources.
typestring
runTimeDeduplication
descriptionMethod used to de-duplicate run-times when batch scheduling is performed. If not specified, a deduplication by DAY will be applied.
enum
  • RUN_TIME_DEDUPLICATION_UNSPECIFIED
  • DISABLED
  • TEMPLATED_PARAMETERS
  • MINUTE
  • HOUR
  • DAY
  • MONTH
  • YEAR
enumDescriptions
  • No method specified and default de-duplication by DAY will be applied.
  • De-duplication is explicitly disabled.
  • Compare values of templated transfer parameters evaluated for each run-time.
  • Compare run-times with a precision up to a minute.
  • Compare run-times with a precision up to an hour.
  • Compare run-times with a precision up to a day.
  • Compare run-times with a precision up to a month.
  • Compare year of each run-time.
typestring
runTimeNormalized
descriptionIndicates that the normalized runtime, instead of the granular runtime, should be used.
typeboolean
scopes
descriptionApi auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
items
typestring
typearray
supportServiceAccount
descriptionOutput only. Indicates if the data source supports service account to authorize data transfer.
readOnlyTrue
typeboolean
supportsCmek
descriptionSpecifies whether the data source supports using CMEK keys to encrypt data.
typeboolean
supportsCustomSchedule
descriptionSpecifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule.
typeboolean
supportsMultipleTransfers
deprecatedTrue
descriptionDeprecated. This field has no effect.
typeboolean
transferType
deprecatedTrue
descriptionDeprecated. This field has no effect.
enum
  • TRANSFER_TYPE_UNSPECIFIED
  • BATCH
  • STREAMING
enumDescriptions
  • Invalid or Unknown transfer type placeholder.
  • Batch data transfer.
  • Streaming data transfer. Streaming data source currently doesn't support multiple transfer configs per project.
typestring
updateDeadlineSeconds
descriptionThe number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
formatint32
typeinteger
useNotNormalizedRunTime
deprecatedTrue
descriptionDeprecated. This field has no effect.
typeboolean
typeobject
DataSourceDefinition
descriptionRepresents the data source definition.
idDataSourceDefinition
properties
allowJobsCreatePermissions
descriptionIndicate if it is allowed to loosening the permission check for this data source to check bigquery.jobs.create permission if the request user doesn't have transfer.* permission for some API calls such as create, update, delete and get transfer config.
typeboolean
allowOptionalDestination
descriptionIndicate if empty destination is allowed for transfer configs of data source.
typeboolean
alwaysUseUserCredentials
descriptionIff true, this data source only sends job requests with use_user_credentials, and it does not add the P4SA to the destination dataset during CreateTransferConfig or UpdateTransferConfig.
typeboolean
backfillBlacklist
additionalProperties
typestring
descriptionProjects for which backfill is disabled. Key is the project id, value is not used
typeobject
blacklistedProjects
descriptionProject numbers for which transfer service will be prohibited. These projects will not even see the data source in transfers tab, and all their configs will not be scheduled.
items
formatint64
typestring
typearray
dataSource
$refDataSource
descriptionData source metadata.
disabled
descriptionIs data source disabled? If true, data_source is not visible. API will also stop returning any data transfer configs and/or runs associated with the data source. This setting has higher priority than whitelisted_project_ids.
typeboolean
endpoint
descriptionEndpoint for the data source for various operations (browse, more in the future). Currently only blade endpoint is supported. If "{location}" is found in the value, then that means, data source wants to handle calls separately in different regions. We will replace {location} with the actual service location, as the actual endpoint. For example, blade:cloud.hosted.datanow.api.clh.datanowclh-staging-qual-{location} could become blade:cloud.hosted.datanow.api.clh.datanowclh-staging-qual-us-central1. If "{location}" is not found, then we will use the input value as endpoint.
typestring
endpointOptions
$refEndpointOptions
descriptionOptions for endpoint.
exportMetricsToCloudMonarch
descriptionA temporary flag to control which data sources can write dts metrics to cloud monarch. TODO(b/176839544) Remove this flag after dts cloud monitoring is generally available.
typeboolean
freeDataSource
descriptionIs data source free. This means that projects do not require billing to be enabled.
typeboolean
labels
additionalProperties
typestring
descriptionUser labels to add to the scheduled runs.
typeobject
name
descriptionIdentifier. The resource name of the data source definition. Data source definition names have the form `projects/{project_id}/locations/{location}/dataSourceDefinitions/{data_source_id}`.
typestring
perProjectMinimumScheduleInterval
additionalProperties
formatgoogle-duration
typestring
descriptionPer project id minimum schedule interval overrides. Key is the project id and Value is a time interval duration.
typeobject
perProjectRunDelay
additionalProperties
formatgoogle-duration
typestring
descriptionOverrides per_project_run_delay for a given project. Key is the project id.
typeobject
perProjectRunTimeOffset
additionalProperties
formatgoogle-duration
typestring
descriptionOverrides per_project_run_time_offset for a given project. Key is the project id.
typeobject
publicDataSource
descriptionIs data source publicly available.
typeboolean
pubsubEncryptionConfig
$refPubsubEncryptionConfig
descriptionThe Pub/Sub messages encryption configuration.
refreshDuration
descriptionAmount of time after schedule_time to keep checking a run. Only applicable for automatically scheduled runs on data sources supporting continuous data refresh.
formatgoogle-duration
typestring
refreshInterval
descriptionFor data sources that support continuous data refresh, how often to recheck recent runs for new data. Use 0 if not supported.
formatgoogle-duration
typestring
runDelay
descriptionThe delay between the schedule times of transfer runs for the same transfer config. Default delay is 15 seconds.
formatgoogle-duration
typestring
runTimeOffset
descriptionDuration which should be added to schedule_time to calculate run_time when job is scheduled. Only applicable for automatically scheduled transfer runs. Used to start a run early on a data source that supports continuous data refresh to compensate for unknown timezone offsets. Use a negative number to start a run late for data sources not supporting continuous data refresh.
formatgoogle-duration
typestring
serviceAccount
descriptionWhen service account is specified, BigQuery will share created dataset with the given service account. Also, this service account will be eligible to perform status updates and message logging for data transfer runs for the corresponding data_source_id.
typestring
serviceAccountId
descriptionGaia id of the service account. It's ok to set either of the parameters. Also it is ok to set both parameters, but they must really correspond to each other, otherwise config will be discarded during validation.
formatint64
typestring
supportEmail
descriptionSupport e-mail address of the OAuth client's Brand, which contains the consent screen data.
typestring
supportServiceAccount
descriptionIndicate if service account authentication is supported for the data source. Defaults to false.
typeboolean
supportedLocationIds
descriptionSupported location_ids used for deciding in which locations Pub/Sub topics need to be created. If custom Pub/Sub topics are used and they contains '{location}', the location_ids will be used for validating the topics by replacing the '{location}' with the individual location in the list. The valid values are the "location_id" field of the response of `GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations` In addition, if the data source needs to support all available regions, supported_location_ids can be set to "global" (a single string element). When "global" is specified: 1) the data source implementation is supposed to stage the data in proper region of the destination dataset; 2) Data source developer should be aware of the implications (e.g., network traffic latency, potential charge associated with cross-region traffic, etc.) of supporting the "global" region;
items
typestring
typearray
supportsPushQueue
descriptionIf set, the data source supports the push queue model for processing transfer runs and subtasks instead of Pub/Sub (go/dts-onto-boq).
typeboolean
transferConfigPubsubTopic
descriptionThe Pub/Sub topic to use for broadcasting a message for transfer config. If empty, a message will not be broadcasted. Both this topic and transfer_run_pubsub_topic are auto-generated if none of them is provided when creating the definition. It is recommended to provide transfer_config_pubsub_topic if a user-owned transfer_run_pubsub_topic is provided. Otherwise, it will be set to empty. If "{location}" is found in the value, then that means, data source wants to handle message separately for datasets in different regions. We will replace {location} with the actual dataset location, as the actual topic name. For example, projects/connector/topics/scheduler-{location} could become projects/connector/topics/scheduler-us. If "{location}" is not found, then we will use the input value as topic name.
typestring
transferRunPubsubTopic
descriptionThe Pub/Sub topic to be used for broadcasting a message when a transfer run is created. Both this topic and transfer_config_pubsub_topic can be set to a custom topic. By default, both topics are auto-generated if none of them is provided when creating the definition. However, if one topic is manually set, the other topic has to be manually set as well. The only difference is that transfer_run_pubsub_topic must be a non-empty Pub/Sub topic, but transfer_config_pubsub_topic can be set to empty. The comments about "{location}" for transfer_config_pubsub_topic apply here too.
typestring
transferRunsPushQueue
descriptionThe name of the push queue to dispatch transfer runs if the data source supports the push queue model (go/dts-onto-boq). Only applicable if supports_push_queue is true.
typestring
transferSubtaskOverallStateNotification
descriptionThe transfer subtask overall state notification setting.
enum
  • TRANSFER_SUBTASK_OVERALL_STATE_NOTIFICATION_UNSPECIFIED
  • ON_SUCCESS
  • ON_SUCCESS_OR_FAILURE
enumDescriptions
  • Type unspecified. This defaults to `ON_SUCCESS` at application layer for backward compatibility.
  • A notification will be sent only when all subtasks succeed.
  • A notification will be sent when either of the condition is met: 1) All subtasks succeed. 2) At least one subtask fails.
typestring
transferSubtaskPubsubTopic
descriptionRequired. The Pub/Sub topic to use for broadcasting a message for transfer subtask. The comments about "{location}" for transfer_config_pubsub_topic apply here too.
typestring
transferSubtasksPushQueue
descriptionThe name of the push queue to dispatch transfer subtasks if the data source supports the push queue model (go/dts-onto-boq). Only applicable if supports_push_queue is true.
typestring
userOwnedTopics
descriptionRequired. Are Pub/Sub topics manually-set and owned by data source owner. By default, DTS automatically generates various Pub/Sub topics if no topics are provided when creating the data source definition. The Pub/Sub topics are also allowed to be changed after data source creation. In that case, the original auto-generated topics will be deleted.
typeboolean
whitelistedProjects
descriptionProject numbers for which data source should be visible. Empty means "all projects". This parameter is useful for trusted testers.
items
formatint64
typestring
typearray
typeobject
DataSourceParameter
descriptionA parameter used to define custom fields in a data source definition.
idDataSourceParameter
properties
allowedValues
descriptionAll possible values for the parameter.
items
typestring
typearray
dataContexts
descriptionRequired if special cares are needed for this parameter.
items
enum
  • DATA_CONTEXT_UNSPECIFIED
  • DATA_CONTEXT_CORE_CONTENT
  • DATA_CONTEXT_SENSITIVE
enumDescriptions
  • Type unspecified.
  • Customer Core Content like query text.
  • Sensitive content like Amazon S3 secrets.
typestring
typearray
defaultValue
descriptionDefault value that will be set in the UI for new transfer configs.
typestring
deprecated
descriptionIf true, it should not be used in new transfers, and it should not be visible to users.
typeboolean
description
descriptionParameter description.
typestring
displayName
descriptionParameter display name in the user interface.
typestring
displaySection
descriptionAllows to group related parameters into display sections. This approach can be further extended by allowing the order of the sections to be specified as a list parameter of the data source.
typestring
displaySuffix
descriptionDescription that will display inline after the original field - this will make the previous input field smaller and display some text after it. For instance, use this to display a url suffix so the user can input a subdomain. e.g. | [INPUT] .google.com |
typestring
fields
descriptionDeprecated. This field has no effect.
items
$refDataSourceParameter
typearray
hidden
descriptionIf true, this parameter will not be exposed to users. However, incoming requests with a parameter that's hidden will be accepted. e.g. CreateTransferConfigRequest.
typeboolean
immutable
descriptionCannot be changed after initial creation.
typeboolean
isSensitive
deprecatedTrue
descriptionDeprecated. This field has no effect.
typeboolean
maxValue
descriptionFor integer and double values specifies maximum allowed value.
formatdouble
typenumber
minValue
descriptionFor integer and double values specifies minimum allowed value.
formatdouble
typenumber
ownerRestricted
descriptionIff true, only the owner of the transfer config can modify this parameter.
typeboolean
paramId
descriptionParameter identifier.
typestring
paramWhitelistedProjects
descriptionContains a list of projects which can access this data source parameter. Empty list of no list means the data source parameter is open to all projects.
items
formatint64
typestring
typearray
recurse
descriptionDeprecated. This field has no effect.
typeboolean
repeated
descriptionDeprecated. This field has no effect.
typeboolean
required
descriptionIs parameter required.
typeboolean
type
descriptionParameter type.
enum
  • TYPE_UNSPECIFIED
  • STRING
  • INTEGER
  • DOUBLE
  • BOOLEAN
  • RECORD
  • PLUS_PAGE
  • LIST
enumDescriptions
  • Type unspecified.
  • String parameter.
  • Integer parameter (64-bits). Will be serialized to json as string.
  • Double precision floating point parameter.
  • Boolean parameter.
  • Deprecated. This field has no effect.
  • Page ID for a Google+ Page.
  • List of strings parameter.
typestring
validationDescription
descriptionDescription of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
typestring
validationHelpUrl
descriptionURL to a help document to further explain the naming requirements.
typestring
validationRegex
descriptionRegular expression which can be used for parameter validation.
typestring
typeobject
DatasetReference
descriptionIdentifier for a dataset.
idDatasetReference
properties
datasetId
descriptionRequired. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
typestring
projectId
descriptionOptional. The ID of the project containing this dataset.
typestring
typeobject
DtsTenantProject
descriptionDefinition of a dts tenant project.
idDtsTenantProject
properties
name
descriptionThe resource name of the dts tenant project. Format: projects/{project_id}/locations/{location_id}/dtsTenantProjects/{tenant_id} {project_id} is the consumer project number. {tenant_id} is the user specified id for the dts tenant project. Note this is NOT the GCP project id.
typestring
project
descriptionOutput only. Identifier of the dts tenant project in the form `projects/{number}`. For example "projects/123456".
readOnlyTrue
typestring
state
descriptionOutput only. State of tenant project.
enum
  • STATE_UNSPECIFIED
  • ACTIVE
  • FAILED
enumDescriptions
  • Unspecified status is the default unset value.
  • Active tenant project.
  • Tenant project creation or deletion has failed.
readOnlyTrue
typestring
typeobject
EmailPreferences
descriptionRepresents preferences for sending email notifications for transfer run events.
idEmailPreferences
properties
enableFailureEmail
descriptionIf true, email notifications will be sent on transfer run failures.
typeboolean
typeobject
Empty
descriptionA 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); }
idEmpty
properties
typeobject
EnableDataTransferServiceRequest
descriptionA request to enable data transfer service for a project.
idEnableDataTransferServiceRequest
properties
typeobject
EncryptionConfiguration
descriptionRepresents the encryption configuration for a transfer.
idEncryptionConfiguration
properties
kmsKeyName
descriptionThe name of the KMS key used for encrypting BigQuery data.
typestring
typeobject
EndpointOptions
descriptionOptions for endpoint.
idEndpointOptions
properties
mapMultiRegionToCollapsed
descriptionFlag to indicate the region replacement for the endpoint will map multi region into the collapsed region, i.e., us -> us-central1, eu -> europe-west4.
typeboolean
typeobject
EnrollDataSourcesRequest
descriptionA request to enroll a set of data sources so they are visible in the BigQuery UI's `Transfer` tab.
idEnrollDataSourcesRequest
properties
dataSourceIds
descriptionData sources that are enrolled. It is required to provide at least one data source id.
items
typestring
typearray
typeobject
EventDrivenSchedule
descriptionOptions customizing EventDriven transfers schedule.
idEventDrivenSchedule
properties
pubsubSubscription
descriptionPub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project}/subscriptions/{subscription}
typestring
typeobject
Experiment
descriptionRepresents experiment to corresponding to the project.
idExperiment
properties
enabled
descriptionThe boolean of enabled.
typeboolean
name
descriptionRequired. The name of flag. Format: `projects/{project_id}/locations/{location_id}/experiments/{flag_name}`
typestring
typeobject
ExperimentInfo
descriptionInformation related to mendel experiments.
idExperimentInfo
properties
enabledExperimentIds
descriptionExperiment ids that are selected to be logged.
items
formatint32
typeinteger
typearray
enabledExperiments
descriptionExperiment flag names that are enabled.
items
typestring
typearray
typeobject
FieldElementType
descriptionRepresents the type of a field element.
idFieldElementType
properties
type
descriptionRequired. The type of a field element. For more information, see ImportedDataInfo.FieldSchema.type.
enum
  • TYPE_UNSPECIFIED
  • STRING
  • INTEGER
  • FLOAT
  • RECORD
  • BYTES
  • BOOLEAN
  • TIMESTAMP
  • DATE
  • TIME
  • DATETIME
  • NUMERIC
  • GEOGRAPHY
  • BIGNUMERIC
  • JSON
  • RANGE
enumDescriptions
  • Illegal value.
  • 64K, UTF8.
  • 64-bit signed.
  • 64-bit IEEE floating point.
  • Aggregate type.
  • 64K, Binary.
  • 2-valued.
  • 64-bit signed usec since UTC epoch.
  • Civil date - Year, Month, Day.
  • Civil time - Hour, Minute, Second, Microseconds.
  • Combination of civil date and civil time.
  • Numeric type with 38 decimal digits of precision and 9 decimal digits of scale.
  • Geography object (go/googlesql_geography).
  • BigNumeric type with granularity 10^-38, min value -2^255 x 10^-38 and max value roughly (2^255 - 1) x 10^-38.
  • JSON type.
  • RANGE type.
typestring
typeobject
FieldSchema
descriptionDefines schema of a field in the imported data.
idFieldSchema
properties
description
descriptionDescription for this field.
typestring
fieldName
descriptionField name. Matches: A-Za-z_{0,127}
typestring
isRepeated
descriptionIs field repeated.
typeboolean
isRequired
descriptionIs field required. Used only if `is_repeated` is set to false.
typeboolean
rangeElementType
$refFieldElementType
descriptionRequired if the type of the field is RANGE. The value can be one of the following: * `DATE` * `DATETIME` * `TIMESTAMP`
schema
$refRecordSchema
descriptionPresent iff type == RECORD.
type
descriptionField type
enum
  • TYPE_UNSPECIFIED
  • STRING
  • INTEGER
  • FLOAT
  • RECORD
  • BYTES
  • BOOLEAN
  • TIMESTAMP
  • DATE
  • TIME
  • DATETIME
  • NUMERIC
  • GEOGRAPHY
  • BIGNUMERIC
  • JSON
  • RANGE
enumDescriptions
  • Illegal value.
  • 64K, UTF8.
  • 64-bit signed.
  • 64-bit IEEE floating point.
  • Aggregate type.
  • 64K, Binary.
  • 2-valued.
  • 64-bit signed usec since UTC epoch.
  • Civil date - Year, Month, Day.
  • Civil time - Hour, Minute, Second, Microseconds.
  • Combination of civil date and civil time.
  • Numeric type with 38 decimal digits of precision and 9 decimal digits of scale.
  • Geography object (go/googlesql_geography).
  • BigNumeric type with granularity 10^-38, min value -2^255 x 10^-38 and max value roughly (2^255 - 1) x 10^-38.
  • JSON type.
  • RANGE type.
typestring
typeParameters
$refTypeParameters
descriptionType Parameters for NUMERIC, STRING or BYTES types
typeobject
FinishRunRequest
descriptionA request to finish a run.
idFinishRunRequest
properties
typeobject
GetOrCreateDtsTenantProjectRequest
descriptionRepresents a request of GetOrCreateDtsTenantProject method.
idGetOrCreateDtsTenantProjectRequest
properties
tenantId
descriptionRequired. The ID for the dts tenant project, which will become the final component of the dts tenant project's resource name. The id must be unique within the parent, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?. The id must NOT be a UUID-like string.
typestring
typeobject
ImportedDataInfo
descriptionDescribes data which should be imported.
idImportedDataInfo
properties
clustering
$refClustering
descriptionOne or more fields on which data should be clustered.
columnAddition
descriptionEnable new column addition.
typeboolean
createDisposition
descriptionSpecifies whether the job is allowed to create new tables.
enum
  • CREATE_DISPOSITION_UNSPECIFIED
  • CREATE_NEVER
  • CREATE_IF_NEEDED
enumDescriptions
  • The default createDispostion
  • The table must already exist. If it does not, a 'notFound' error is returned in the job result.
  • If the table does not exist, BigQuery creates the table.
typestring
dataVersion
descriptionData version associated with the data for this job. Used for deduplicating and ordering jobs.
typestring
deleteSourceFiles
descriptionWhen set BigQuery DTS will perform best effort delete of the source files after the BigQuery load job succeeds.
typeboolean
destinationExpirationTime
descriptionThe time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
formatgoogle-datetime
typestring
destinationTableDescription
descriptionThe description of a destination table. This can be several sentences or paragraphs describing the table contents in detail.
typestring
destinationTableId
descriptionTable where results should be written.
typestring
destinationTableKmsKey
descriptionOptional. Optional cloud KMS encryption key. When not specified default encryption is used.
typestring
jobProjectId
descriptionIf specified, jobs are billed to this project_id, rather than project_id of the TransferRun.
typestring
maximumBytesBilled
descriptionOptional maximum bytes billed. If specified, query job will fail if exceeding the maximum bytes billed.
formatint64
typestring
parameters
descriptionA list of named parameters for query job.
items
$refQueryParameter
typearray
queryType
descriptionQuery type based on the enum, e.g. DML.
enum
  • QUERY_JOB_TYPE_UNSPECIFIED
  • DEFAULT_QUERY
  • DML
enumDescriptions
  • Query job type unspecified
  • Regular query
  • DML
typestring
rangePartitioning
$refRangePartitioning
descriptionRange partitioning information for destination table (present only for partitioned tables).
requestedJobId
descriptionOptional parameter allowing to assign a specific ID to BigQuery job loading the data. When set, only a single BigQuery job can be started per ImportedDataInfo and the job will not be retried if failed. When not specified, DTS will generate the ID and can start more than one BigQuery job to load the data in ImportedDataInfo. This field is currently used only by transfer/resource_state_controller.cc and is not expected to be set by a datasource directly.
typestring
schemaAutodetection
descriptionEnable schema autodetection.
typeboolean
sql
descriptionSQL query to run. When empty, API checks that there is only one table_def specified and loads this table. Only GoogleSQL queries are accepted. Legacy SQL is not allowed.
typestring
tableDefs
descriptionWhen used WITHOUT the "sql" parameter, describes the schema of the destination table. When used WITH the "sql" parameter, describes tables with data stored outside of BigQuery.
items
$refTableDefinition
typearray
thinmint
descriptionSerialized thinmint that is required when data is stored on Colossus or Placer. If not populated, then thinmint from the request is used.
formatbyte
typestring
timePartitioning
$refTimePartitioning
descriptionTime partitioning information for destination table (present only for partitioned tables).
userDefinedFunctions
descriptionInline code for User-defined function resources. Ignored when "sql" parameter is empty.
items
typestring
typearray
writeDisposition
descriptionSpecifies the action if the destination table already exists.
enum
  • WRITE_DISPOSITION_UNSPECIFIED
  • WRITE_TRUNCATE
  • WRITE_APPEND
  • WRITE_EMPTY
enumDescriptions
  • The default writeDispostion
  • overwrites the table data.
  • the data is appended to the table. Note duplication might happen if this mode is used.
  • This job should only be writing to empty tables.
typestring
typeobject
IsDataTransferServiceEnabledRequest
descriptionA request to determine whether data transfer is enabled for the project.
idIsDataTransferServiceEnabledRequest
properties
typeobject
IsDataTransferServiceEnabledResponse
descriptionA response to indicate whether data transfer service is enabled for the project.
idIsDataTransferServiceEnabledResponse
properties
enabled
descriptionIndicates whether the data transfer service is enabled for the project.
typeboolean
reason
descriptionA string that contains additional information about why the service is deemed not enabled. This is only available when `enable` is false.
typestring
typeobject
JobCounts
descriptionMessage describing the count of jobs in various success and execution states.
idJobCounts
properties
active
descriptionThe count of jobs that are currently executing.
formatint32
typeinteger
failed
descriptionThe count of jobs that finished and had an error.
formatint32
typeinteger
idle
descriptionThe count of jobs that are neither finished nor running. For example, these jobs could be waiting on a condition to change to start execution, such as when the number of concurrently active jobs is constrained.
formatint32
typeinteger
succeeded
descriptionThe count of jobs that finished and succeeded (do not have an error).
formatint32
typeinteger
typeobject
KeystoreEncryption
descriptionKeystore encryption configuration.
idKeystoreEncryption
properties
keystoreConfigId
descriptionKeystore config ID.
formatint32
typeinteger
keystoreKeymasterServiceKey
descriptionKeystore keymaster service key name.
typestring
typeobject
ListDataSourceDefinitionsResponse
descriptionReturns a list of supported data source definitions.
idListDataSourceDefinitionsResponse
properties
dataSourceDefinitions
descriptionList of supported data source definitions.
items
$refDataSourceDefinition
typearray
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourceDefinitionsRequest.page_token` to request the next page of the list results.
readOnlyTrue
typestring
typeobject
ListDataSourcesResponse
descriptionReturns list of supported data sources and their metadata.
idListDataSourcesResponse
properties
dataSources
descriptionList of supported data sources and their transfer settings.
items
$refDataSource
typearray
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListDataSourcesRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
typeobject
ListExperimentsResponse
descriptionRepresents a response of all the experiments of the project.
idListExperimentsResponse
properties
experiments
descriptionOutput only. The name of requested project that consumes the dts experiments. Format: `projects/{project_id}/locations/{location_id}/experiments`
items
$refExperiment
readOnlyTrue
typearray
typeobject
ListLocationsResponse
descriptionThe response message for Locations.ListLocations.
idListLocationsResponse
properties
locations
descriptionA list of locations that matches the specified filter in the request.
items
$refLocation
typearray
nextPageToken
descriptionThe standard List next-page token.
typestring
typeobject
ListTransferConfigsResponse
descriptionThe returned list of pipelines in the project.
idListTransferConfigsResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferConfigsRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
transferConfigs
descriptionOutput only. The stored pipeline transfer configurations.
items
$refTransferConfig
readOnlyTrue
typearray
typeobject
ListTransferLogsResponse
descriptionThe returned list transfer run messages.
idListTransferLogsResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `GetTransferRunLogRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
transferMessages
descriptionOutput only. The stored pipeline transfer messages.
items
$refTransferMessage
readOnlyTrue
typearray
typeobject
ListTransferRunsResponse
descriptionThe returned list of pipelines in the project.
idListTransferRunsResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
transferRuns
descriptionOutput only. The stored pipeline transfer runs.
items
$refTransferRun
readOnlyTrue
typearray
typeobject
ListTransferSubtasksResponse
descriptionThe returned list of subtasks for the particular transfer run.
idListTransferSubtasksResponse
properties
nextPageToken
descriptionOutput only. The next-pagination token. For multiple-page list results, this token can be used as the `ListTransferRunsRequest.page_token` to request the next page of list results.
readOnlyTrue
typestring
subtasks
descriptionOutput only. The stored subtasks.
items
$refTransferSubtask
readOnlyTrue
typearray
typeobject
Location
descriptionA resource that represents a Google Cloud location.
idLocation
properties
displayName
descriptionThe friendly name for this location, typically a nearby city name. For example, "Tokyo".
typestring
labels
additionalProperties
typestring
descriptionCross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
typeobject
locationId
descriptionThe canonical id for this location. For example: `"us-east1"`.
typestring
metadata
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
descriptionService-specific metadata. For example the available capacity at the given location.
typeobject
name
descriptionResource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
typestring
typeobject
Log3PTosAcceptedRequest
descriptionA request to log a consent event when users accept the TOS before creating or changing a transfer config for a 3rd party data source.
idLog3PTosAcceptedRequest
properties
auditRenderDataToken
descriptionAlternatively, the client can replace build label, build cl and language code with an audit render data token which includes all three pieces of info in an encrypted string.
typestring
buildCl
descriptionBigQuery client build cl (rollup Cl).
formatint64
typestring
buildLabel
descriptionBigQuery client build label.
typestring
dataSourceId
description3rd party data source id.
typestring
datasetId
descriptionThe user-selected dataset id.
typestring
languageCode
descriptionThe language code in which the BigQuery UI was presented to the user. The language code has to conform to the CLDR (https://unicode.org/cldr/) specification (which is based on the BCP 47) identifier system (see cs/symbol:com.google.i18n.identifiers.LanguageCode for more information about the format of the supported language codes).
typestring
uiContext
descriptionIndicates the UI context when the requests is made.
enum
  • UI_CONTEXT_UNSPECIFIED
  • CREATING_CONFIG
  • EDITING_CONFIG
enumDescriptions
  • Type unspecified.
  • Creating a transfer config.
  • Editing a transfer config.
typestring
typeobject
LogTransferRunMessagesRequest
descriptionA request to add transfer status messages to the run.
idLogTransferRunMessagesRequest
properties
transferMessages
descriptionMessages to append.
items
$refTransferMessage
typearray
typeobject
ManualSchedule
descriptionOptions customizing manual transfers schedule.
idManualSchedule
properties
typeobject
MonitorBigQueryJobsRequest
descriptionA request to monitor an existing BigQuery load job.
idMonitorBigQueryJobsRequest
properties
cloudRegionName
descriptionCloudRegion name for HelixJob's location. It will override the region inferred from transfer run name if specified. Helix Cloudregion enum is not used here as proto2 enum is not supported in proto3.
typestring
jobs
descriptionJobs to be monitored.
items
$refBigQueryJobMonitoringInfo
typearray
thinmint
descriptionSerialized thinmint that is required when data is stored on Colossus or Placer.
formatbyte
typestring
useUserCredentials
descriptionWhen this is set to true, we use the user credentials to monitor BigQuery job.
typeboolean
userCredentials
descriptionUser credentials which should be used to start/monitor BigQuery jobs. If not specified, then jobs are started using data source service account credentials. This may be OAuth token or JWT token.
formatbyte
typestring
typeobject
ParquetOptions
descriptionParquet Options for load and make external tables.
idParquetOptions
properties
enableListInference
descriptionOptional. Indicates whether to use schema inference specifically for Parquet LIST logical type.
typeboolean
enumAsString
descriptionOptional. Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
typeboolean
mapTargetType
descriptionOptional. Indicates how to represent a Parquet map if present.
enum
  • MAP_TARGET_TYPE_UNSPECIFIED
  • ARRAY_OF_STRUCT
enumDescriptions
  • In this mode, the map will have the following schema: struct map_field_name { repeated struct key_value { key value } }.
  • In this mode, the map will have the following schema: repeated struct map_field_name { key value }.
typestring
typeobject
PartitionTransferConfigsRequest
descriptionA request to partition data transfer configs, so that they can be streamed in parallel.
idPartitionTransferConfigsRequest
properties
dataSourceIds
descriptionList of data source ids for which data transfer configs should be returned.
items
typestring
typearray
desiredPartitionSizeBytes
descriptionDesired partition data size in bytes.
formatint64
typestring
typeobject
PartitionTransferConfigsResponse
descriptionRepresents partitioning info that can be used to stream transfer configs in parallel. Returned token is valid for at least 2 hours.
idPartitionTransferConfigsResponse
properties
partitions
descriptionSet of partitions. Any subset of them can be passed to StreamTransferConfigs method.
items
typestring
typearray
token
descriptionToken that must be passed to StreamTransferConfigs method.
typestring
typeobject
PartitionTransferRunsRequest
descriptionA request to partition data transfer runs so that they can be streamed in parallel.
idPartitionTransferRunsRequest
properties
dataSourceIds
descriptionList of data source ids for which data transfer configs should be returned.
items
typestring
typearray
desiredPartitionSizeBytes
descriptionDesired partition data size in bytes.
formatint64
typestring
minScheduleTime
descriptionWhen specified, adds an extra filter to select runs scheduled on or after the time specified.
formatgoogle-datetime
typestring
states
descriptionList of run states to return.
items
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
typestring
typearray
typeobject
PartitionTransferRunsResponse
descriptionRepresents partitioning info that can be used to stream transfer runs in parallel. Returned token is valid for at least 2 hours.
idPartitionTransferRunsResponse
properties
partitions
descriptionSet of partitions. Any subset of them can be passed to StreamTransferRuns method.
items
typestring
typearray
token
descriptionToken that must be passed to StreamTransferRuns method.
typestring
typeobject
PlayDataSourceUsageEntry
descriptionA usage entry of Play usage for a transfer run.
idPlayDataSourceUsageEntry
properties
playPackages
descriptionRequired. The packages transferred in the run.
items
typestring
typearray
typeobject
PubsubEncryptionConfig
descriptionThe encryption option for Pub/Sub messages. The default value means messages are not encrypted. If encryption is enabled, the Pub/Sub message data is encrypted after serialization, and message attributes key/value pairs are set to provide encryption metadata. For examples: -- Unencrypted -- PubsubMessage { "data": serialized(TransferRun message) "attributes": {} } -- Encrypted with Keystore -- PubsubMessage { "data": encrypted(serialized(TransferRun message)) "attributes": { "keystore_config_id": 72667, "keystore_keymaster_service_key": "some_key_name" } } This option curerently applies to transfer_run_pubsub_topic and transfer_subtask_pubsub_topic.
idPubsubEncryptionConfig
properties
keystoreEncryption
$refKeystoreEncryption
descriptionEncryption using Keystore keys.
typeobject
QueryParameter
descriptionA user-specified parameter for query execution.
idQueryParameter
properties
parameterName
descriptionName of the parameter.
typestring
typeKind
descriptionThe type of the parameter. Only Timestamp is supported now. Default is timestamp.
enum
  • TYPE_KIND_UNSPECIFIED
  • TYPE_INT64
  • TYPE_BOOL
  • TYPE_FLOAT_64
  • TYPE_STRING
  • TYPE_BYTES
  • TYPE_TIMESTAMP
  • TYPE_DATE
  • TYPE_TIME
  • TYPE_DATETIME
  • TYPE_GEOGRAPHY
  • TYPE_ARRAY
  • TYPE_STRUCT
  • TYPE_NUMERIC
  • TYPE_BIGNUMERIC
  • TYPE_JSON
  • TYPE_RANGE
enumDescriptions
  • Invalid type.
  • A string in decimal format.
  • A boolean "false" or "true".
  • A number, or string "NaN", "Infinity" or "-Infinity".
  • A string value.
  • A base64 string per RFC 4648, section 4.
  • An RFC 3339 timestamp with mandatory "Z" time zone string: 1985-04-12T23:20:50.52Z
  • An RFC 3339 full-date format string: 1985-04-12
  • An RFC 3339 partial-time format string: 23:20:50.52
  • An RFC 3339 full-date "T" partial-time: 1985-04-12T23:20:50.52
  • A WKT
  • A list with types matching Type.array_type.
  • A list with fields of type Type.struct_type[i].
  • A string in decimal format.
  • A string in decimal format.
  • A json value.
  • A range value.
typestring
value
descriptionValue of the parameter.
typestring
typeobject
Range
descriptionDefines the ranges for range partitioning.
idRange
properties
end
descriptionRequired. The end of range partitioning, exclusive. This field is an INT64 value represented as a string.
typestring
interval
descriptionRequired. The width of each interval. This field is an INT64 value represented as a string.
typestring
start
descriptionRequired. The start of range partitioning, inclusive. This field is an INT64 value represented as a string.
typestring
typeobject
RangePartitioning
idRangePartitioning
properties
field
descriptionRequired. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED.
typestring
range
$refRange
descriptionDefines the ranges for range partitioning.
typeobject
RecordSchema
descriptionDescribes schema of the data to be ingested.
idRecordSchema
properties
fields
descriptionOne field per column in the record.
items
$refFieldSchema
typearray
typeobject
RecordTransferRunBillingMeasurementRequest
descriptionRequest to record transfer run billing measurement.
idRecordTransferRunBillingMeasurementRequest
properties
dataSourceId
descriptionstring to indicate the data source type
typestring
measurementEntry
$refTransferRunBillingMeasurementEntry
descriptionA measurement entry to record.
playDataSourceUsageEntry
$refPlayDataSourceUsageEntry
descriptionA usage entry to record Play usage
typeobject
ScheduleOptions
descriptionOptions customizing the data transfer schedule.
idScheduleOptions
properties
disableAutoScheduling
descriptionIf true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.
typeboolean
endTime
descriptionDefines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.
formatgoogle-datetime
typestring
maxScheduledRuns
descriptionLimits the total number of times a transfer config can be started per schedule. Currently supported values: 0 - infinite times, 1 - run once. This field does not limit the number of times a transfer can be started manually.
formatint32
typeinteger
startTime
descriptionSpecifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.
formatgoogle-datetime
typestring
typeobject
ScheduleOptionsV2
descriptionV2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
idScheduleOptionsV2
properties
eventDrivenSchedule
$refEventDrivenSchedule
descriptionEvent driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.
manualSchedule
$refManualSchedule
descriptionManual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.
timeBasedSchedule
$refTimeBasedSchedule
descriptionTime based transfer schedule options. This is the default schedule option.
typeobject
ScheduleTransferRunsRequest
descriptionA request to schedule transfer runs for a time range.
idScheduleTransferRunsRequest
properties
endTime
descriptionRequired. End time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`.
formatgoogle-datetime
typestring
labels
additionalProperties
typestring
descriptionUser labels to add to the scheduled runs.
typeobject
startTime
descriptionRequired. Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`.
formatgoogle-datetime
typestring
typeobject
ScheduleTransferRunsResponse
descriptionA response to schedule transfer runs for a time range.
idScheduleTransferRunsResponse
properties
runs
descriptionThe transfer runs that were scheduled.
items
$refTransferRun
typearray
typeobject
SetEnabledRequest
descriptionA request to set whether data transfer is enabled or disabled for a project.
idSetEnabledRequest
properties
enabled
descriptionWhether data transfer should be enabled or disabled for the project.
typeboolean
typeobject
StartBigQueryJobsRequest
descriptionA request to start and monitor a BigQuery load job.
idStartBigQueryJobsRequest
properties
cloudRegionName
descriptionCloudRegion name for HelixJob's location. It will override the region inferred from transfer run name if specified. Helix Cloudregion enum is not used here as proto2 enum is not supported in proto3.
typestring
copyJob
descriptionDefinition for copy jobs. It is allowed for a start job request to have a mixture of ImportedDataInfo for query and load jobs, and of CopyJobInfo.
items
$refCopyJobInfo
typearray
dataSourceUris
descriptionSource URI of the transfer
items
typestring
typearray
decimalTargetTypes
descriptionSQL data types to which source decimal values are converted. This list along with the precision and scale of the decimal field determine the target type. The order of preference is NUMERIC, BIGNUMERIC, and then STRING. A type is picked if it is in this field and if it supports the given precision and scale. STRING supports all precision and scale values. If none of the provided types support the precision and scale, the type supporting the widest range in the specified list is picked. If a value exceeds the supported range when reading the data, an error will be thrown. For example: suppose decimal_target_type = ["NUMERIC", "BIGNUMERIC"]. Then if (precision,scale) is: * (38,9) -> NUMERIC; * (38,9) -> BIGNUMERIC (NUMERIC cannot hold 38 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC.
items
enum
  • DECIMAL_TARGET_TYPE_UNSPECIFIED
  • NUMERIC
  • BIGNUMERIC
  • STRING
enumDescriptions
  • Invalid type.
  • Decimal values could be converted to NUMERIC type.
  • Decimal values could be converted to BIGNUMERIC type.
  • Decimal values could be converted to STRING type.
typestring
typearray
importedData
descriptionImport jobs which should be started and monitored.
items
$refImportedDataInfo
typearray
maxParallelism
descriptionThe number of BigQuery Jobs that can run in parallel.
formatint32
typeinteger
thinmint
descriptionSerialized thinmint that is required when data is stored on Colossus or Placer.
formatbyte
typestring
useUserCredentials
descriptionWhen this is set to true, we use the user credentials to write data into BigQuery destination dataset. For example, this is used in Scheduled Query data source to force to use user credentials to write to BigQuery, instead of using the p4 service account credentials.
typeboolean
userCredentials
descriptionUser credentials which should be used to start/monitor BigQuery jobs. If not specified, then jobs are started using data source service account credentials. This may be OAuth token or JWT token.
formatbyte
typestring
typeobject
StartManualTransferRunsRequest
descriptionA request to start manual transfer runs.
idStartManualTransferRunsRequest
properties
labels
additionalProperties
typestring
descriptionUser labels to add to the backfilled runs.
typeobject
requestedRunTime
descriptionA run_time timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_run_time must be a past time and cannot include future time values.
formatgoogle-datetime
typestring
requestedTimeRange
$refTimeRange
descriptionA time_range start and end timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_time_range must be a past time and cannot include future time values.
typeobject
StartManualTransferRunsResponse
descriptionA response to start manual transfer runs.
idStartManualTransferRunsResponse
properties
runs
descriptionThe transfer runs that were created.
items
$refTransferRun
typearray
typeobject
Status
descriptionThe `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).
idStatus
properties
code
descriptionThe status code, which should be an enum value of google.rpc.Code.
formatint32
typeinteger
details
descriptionA list of messages that carry the error details. There is a common set of message types for APIs to use.
items
additionalProperties
descriptionProperties of the object. Contains field @type with type URL.
typeany
typeobject
typearray
message
descriptionA 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.
typestring
typeobject
StreamTransferConfigsRequest
descriptionA request to get data transfer configs corresponding to the given partitions.
idStreamTransferConfigsRequest
properties
partitions
descriptionSubset of partitions returned by PartitionTransferConfigs method.
items
typestring
typearray
token
descriptionToken returned by PartitionTransferConfigs method.
typestring
typeobject
StreamTransferRunsRequest
descriptionA request to get data transfer runs corresponding to the given partitions.
idStreamTransferRunsRequest
properties
partitions
descriptionSubset of partitions returned by PartitionTransferRuns method.
items
typestring
typearray
token
descriptionToken returned by PartitionTransferRuns method.
typestring
typeobject
TableDefinition
descriptionExternal table definition. These tables can be referenced with 'name' in the query and can be read just like any other table.
idTableDefinition
properties
avroOptions
$refAvroOptions
descriptionAVRO specific options.
csvOptions
$refCsvOptions
descriptionCSV specific options.
encoding
descriptionCharacter encoding of the input when applicable (CSV, JSON). Defaults to UTF8.
enum
  • ENCODING_UNSPECIFIED
  • ISO_8859_1
  • UTF8
  • UTF16BE
  • UTF16LE
  • UTF32BE
  • UTF32LE
enumDescriptions
  • Default encoding (UTF8).
  • ISO_8859_1 encoding.
  • UTF8 encoding.
  • UTF-16 BigEndian. Only support CSV files.
  • UTF-16 LittleEndian. Only support CSV files.
  • UTF-32 BigEndian. Only support CSV files.
  • UTF-32 LittleEndian. Only support CSV files.
typestring
format
descriptionDescribes the format of the data in source_uri.
enum
  • FORMAT_UNSPECIFIED
  • CSV
  • JSON
  • AVRO
  • RECORDIO
  • COLUMNIO
  • CAPACITOR
  • PARQUET
  • ORC
  • THRIFT
  • ICEBERG
  • DELTA_LAKE
enumDescriptions
  • Unspecified format. In this case, we have to infer the format from the data source.
  • CSV format.
  • Newline-delimited JSON.
  • Avro format. See https://avro.apache.org .
  • RecordIO.
  • ColumnIO.
  • Capacitor.
  • Parquet format. See https://parquet.apache.org .
  • ORC format. See https://orc.apache.org .
  • Thrift format. See https://thrift.apache.org/.
  • Iceberg format. See https://iceberg.apache.org/.
  • Delta lake format. See https://databricks.com/product/delta-lake-on-databricks.
typestring
ignoreUnknownValues
descriptionIndicates if extra values that are not represented in the table schema is allowed.
typeboolean
maxBadRecords
descriptionSpecify the maximum number of bad records that can be ignored. If bad records exceed this threshold the query is aborted.
formatint32
typeinteger
nativeSchema
descriptionOptional internal parameter with a schema in a native format used in BigQuery (TableSchema proto in helix.proto) serialized as bytes to avoid taking a dependency on helix.proto.
formatbyte
typestring
parquetOptions
$refParquetOptions
descriptionPARQUET specific options.
referenceFileSchemaUri
descriptionProvide a reference file with the reader schema. Supported formats: AVRO, PARQUET, ORC.
typestring
schema
$refRecordSchema
descriptionOptional schema for the data. When not specified for JSON and CSV formats we will try to detect it automatically.
sourceUris
descriptionURIs for the data to be imported. All URIs must be from the same storage system.
items
typestring
typearray
tableId
descriptionBigQuery table_id (required). This will be used to reference this table in the query.
typestring
thriftOptions
$refThriftOptions
descriptionTHRIFT specific options;
viewInfo
descriptionInfo to create view
items
$refViewInfo
typearray
typeobject
TableReference
descriptionDefinition for a BigQuery (fully qualified) table reference.
idTableReference
properties
datasetId
descriptionDataset id.
typestring
projectId
descriptionProject id or number.
typestring
tableId
descriptionTable id.
typestring
typeobject
ThriftOptions
descriptionOptions for configuring loading Thrift serialized data.
idThriftOptions
properties
boundaryBytes
descriptionOptional. Sequence of bytes used to separate two serialized Thrift data blocks. When it's used with `framing_option`, the `boundary_bytes` are expected to be in front of the framed block.
formatbyte
typestring
deserializationOption
descriptionOptional. `deserialization_option` sets how the serialized Thrift should be deserialized. The following options are supported: * THRIFT_BINARY_PROTOCOL_OPTION: using TBinaryProtocol to deserialize the data.
enum
  • DESERIALIZATION_OPTION_UNSPECIFIED
  • THRIFT_BINARY_PROTOCOL_OPTION
enumDescriptions
  • Default value. This value is unused.
  • Use `TBinaryProtocol` to deserialize the data..
typestring
framingOption
descriptionOptional. Framing in Thrift means 4 bytes slipped in front of the serialized record or data block to inidicate the size of the followed record or data block. The following options are support: * NOT_FRAMED: Serialized Thrift records or data blocks are not framed, there are no 4-byte record size in front of the record. * FRAMED_WITH_BIG_ENDIAN: Serialized Thrift records or data blocks are framed with the 4-byte record size in big endian. * FRAMED_WITH_LITTLE_ENDIAN: Serialized Thrift records or data blocks are framed with the 4-byte record size in little endian. One option to frame Thrift record at serialization time is using `TFramedTransport`, which writes the 4-byte record or data block size in big endian. By default `framing_option` is set to "NOT_FRAMED".
enum
  • FRAMING_OPTION_UNSPECIFIED
  • NOT_FRAMED
  • FRAMED_WITH_BIG_ENDIAN
  • FRAMED_WITH_LITTLE_ENDIAN
enumDescriptions
  • Default value. This value is unused.
  • Records or data blocks are not framed.
  • Records or data blocks are framed with a 4-byte record size in big endian.
  • Records or data blocks are framed with a 4-byte record size in little endian.
typestring
schemaIdlRootDir
descriptionRequired. The root directory of the IDL file bundle defining the schema. All IDL files that are used to parse the schema should be in this directory. This directory should be different from the source_uris.
typestring
schemaIdlUri
descriptionRequired. The Thrift IDL file in the `schema_idl_root_dir` that should be used as the root file to parse the schema. All included idl files in the `schema_idl_uri` should also be in the `schema_idl_root_dir` or its sub-directory.
typestring
schemaStruct
descriptionRequired. The root struct specified in `schema_idl_uri` that should be used to parse the schema.
typestring
typeobject
TimeBasedSchedule
descriptionOptions customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.
idTimeBasedSchedule
properties
endTime
descriptionDefines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment.
formatgoogle-datetime
typestring
schedule
descriptionData transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
typestring
scheduleOnce
descriptionSpecifies whether the transfer config is scheduled to only run once and remains as an internal field.
typeboolean
startTime
descriptionSpecifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment.
formatgoogle-datetime
typestring
typeobject
TimePartitioning
idTimePartitioning
properties
expirationMs
descriptionOptional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value.
formatint64
typestring
field
descriptionOptional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value.
typestring
requirePartitionFilter
defaultfalse
deprecatedTrue
descriptionIf set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it.
typeboolean
type
descriptionRequired. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
typestring
typeobject
TimeRange
descriptionA specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).
idTimeRange
properties
endTime
descriptionEnd time of the range of transfer runs. For example, `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
formatgoogle-datetime
typestring
startTime
descriptionStart time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
formatgoogle-datetime
typestring
typeobject
TransferConfig
descriptionRepresents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, `destination_dataset_id` specifies where data should be stored. When a new transfer configuration is created, the specified `destination_dataset_id` is created when needed and shared with the appropriate data source service account.
idTransferConfig
properties
callerOwned
descriptionOutput only. Returns True if the caller is the owner of this TransferConfig. This will not be populated if `dataSourceId` is 'youtube_channel'.
readOnlyTrue
typeboolean
createTime
descriptionOutput only. Creation time of the transfer config.
formatgoogle-datetime
readOnlyTrue
typestring
dataRefreshWindowDays
descriptionThe number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
formatint32
typeinteger
dataSourceId
descriptionData source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list
typestring
datasetRegion
descriptionOutput only. Region in which BigQuery dataset is located.
readOnlyTrue
typestring
destinationDataset
$refDatasetReference
descriptionThe BigQuery target dataset.
destinationDatasetId
descriptionThe BigQuery target dataset id.
typestring
disabled
descriptionIs this config disabled. When set to true, no runs will be scheduled for this transfer config.
typeboolean
displayName
descriptionUser specified display name for the data transfer.
typestring
emailPreferences
$refEmailPreferences
descriptionEmail notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
encryptionConfiguration
$refEncryptionConfiguration
descriptionThe encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
error
$refStatus
descriptionOutput only. Error code with detailed information about reason of the latest config failure.
readOnlyTrue
manualRunScheduleType
descriptionOutput only. The manual run scheduling option used by UI.
enum
  • MANUAL_RUN_SCHEDULE_TYPE_UNSPECIFIED
  • MANUAL_RUN_DISABLED
  • SCHEDULE_BACKFILL
  • REFRESH_TRANSFER
  • REFRESH_PROJECTION
enumDescriptions
  • Type unspecified
  • Do not allow schedule manual runs
  • Schedule transfer runs by showing a date range picker
  • Simply refresh the transfer without a run date
  • Refresh the Projection transfer without a run date
readOnlyTrue
typestring
name
descriptionIdentifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
typestring
nextRunTime
descriptionOutput only. Next time when data transfer will run.
formatgoogle-datetime
readOnlyTrue
typestring
nextScheduleTime
descriptionOutput only. Next schedule_time for automatically created transfer runs of this config. Will not be set if config is disabled.
formatgoogle-datetime
readOnlyTrue
typestring
notificationPubsubTopic
descriptionPub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
typestring
originalAuthority
descriptionOutput only. OriginalAuthority of the user who created or updated the config. This will be used for auto-scheduled Transfer Runs. The security credentials library recommends storing this message as a blob. cs/symbol:security.credentials.OriginalAuthority
formatbyte
readOnlyTrue
typestring
ownerInfo
$refUserInfo
descriptionOutput only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated.
readOnlyTrue
params
additionalProperties
descriptionProperties of the object.
typeany
descriptionParameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
typeobject
partnerConnectionInfo
additionalProperties
descriptionProperties of the object.
typeany
descriptionTransfer settings managed by partner data sources. It is stored as key-value pairs and used for DTS UI display purpose only. Two reasons we don't want to store them together with 'params' are: - The connection info is provided by partner and not editable in DTS UI which is different from the immutable parameter. It will be confusing to add another boolean to DataSourceParameter to differentiate them. - The connection info can be any arbitrary key-value pairs. Adding them to params fields requires partner to provide definition for them in data source definition. It will be friendlier to avoid that for partners.
typeobject
partnerToken
descriptionA unique identifier used for identifying a transfer setup stored on external partner side. The token is opaque to DTS and can only be interpreted by partner. Partner data source should create a mapping between the config id and the token to validate that a transfer config/run is legitimate.
typestring
schedule
descriptionData transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
typestring
scheduleOptions
$refScheduleOptions
descriptionOptions customizing the data transfer schedule.
scheduleOptionsV2
$refScheduleOptionsV2
descriptionOptions customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
state
descriptionOutput only. State of the most recently updated transfer run.
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
readOnlyTrue
typestring
tableFilters
descriptionTables that need to be loaded. If it's empty, then all tables will be loaded. Case insensitive.
items
typestring
typearray
updateTime
descriptionOutput only. Data transfer modification time. Ignored by server on input.
formatgoogle-datetime
readOnlyTrue
typestring
userId
descriptionDeprecated. Unique ID of the user on whose behalf transfer is done.
formatint64
typestring
typeobject
TransferMessage
descriptionRepresents a user facing message for a particular data transfer run.
idTransferMessage
properties
messageText
descriptionMessage text.
typestring
messageTime
descriptionTime when message was logged.
formatgoogle-datetime
typestring
severity
descriptionMessage severity.
enum
  • MESSAGE_SEVERITY_UNSPECIFIED
  • INFO
  • WARNING
  • ERROR
  • DEBUG
enumDescriptions
  • No severity specified.
  • Informational message.
  • Warning message.
  • Error message.
  • Debug message.
typestring
typeobject
TransferRun
descriptionRepresents a data transfer run.
idTransferRun
properties
cause
descriptionOutput only. Describes the cause for the transfer run creation. This value should not change after the transfer run is created.
enum
  • TRANSFER_CAUSE_UNSPECIFIED
  • RETRY_BY_DATA_SOURCE
  • USER_REQUEST
  • AUTO_SCHEDULE
  • AUTO_SCHEDULE_REFRESH
  • EVENT_DRIVEN
enumDescriptions
  • Cause placeholder.
  • Created for retry.
  • Requested by user.
  • Automatically scheduled.
  • Automatically scheduled for backfill. This is set when 1. a data source defines default_data_refresh_window_days > 1 2. and the auto-scheduled transfer run is for a date in the past.
  • Initiated by event-driven transfer.
readOnlyTrue
typestring
dataSourceId
descriptionOutput only. Data source id.
readOnlyTrue
typestring
dataVersion
descriptionFor data sources that support continuous data refresh, the latest data version that has been loaded. Newer data must have greater (using string compare) data_version (e.g. timestamp in YYYYMMDD HH:MM:SS format).
typestring
datasetRegion
descriptionOutput only. Region in which BigQuery dataset is located.
readOnlyTrue
typestring
destinationDataset
$refDatasetReference
descriptionOutput only. The BigQuery target destination.
readOnlyTrue
destinationDatasetId
descriptionOutput only. The BigQuery target dataset id.
readOnlyTrue
typestring
emailPreferences
$refEmailPreferences
descriptionOutput only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.
readOnlyTrue
encryptionConfiguration
$refEncryptionConfiguration
descriptionThe encryption configuration applied to the transfer run.
endTime
descriptionOutput only. Time when transfer run ended. Parameter ignored by server for input requests.
formatgoogle-datetime
readOnlyTrue
typestring
errorStatus
$refStatus
descriptionStatus of the transfer run.
experimentInfo
$refExperimentInfo
descriptionMendel experiment info for the transfer run.
labels
additionalProperties
typestring
descriptionUser labels.
typeobject
name
descriptionIdentifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.
typestring
notificationPubsubTopic
descriptionOutput only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}`
readOnlyTrue
typestring
originalAuthority
descriptionOutput only. OriginalAuthority of the user who created or updated the config. This will be used for auto-scheduled Transfer Runs. The security credentials library recommends storing this message as a blob. cs/symbol:security.credentials.OriginalAuthority
formatbyte
readOnlyTrue
typestring
params
additionalProperties
descriptionProperties of the object.
typeany
descriptionOutput only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
readOnlyTrue
typeobject
partnerToken
descriptionOutput only. This is the same token initialized from TransferConfig. Partner token is a unique identifier used for identifying a transfer setup stored on external partner side. The token is opaque to DTS and can only be interpreted by partner. Partner data source should create a mapping between the config id and the token to validate that a transfer config/run is legitimate.
readOnlyTrue
typestring
runTime
descriptionFor batch transfer runs, specifies the date and time of the data should be ingested.
formatgoogle-datetime
typestring
schedule
descriptionOutput only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this.
readOnlyTrue
typestring
scheduleTime
descriptionMinimum time after which a transfer run can be started.
formatgoogle-datetime
typestring
startTime
descriptionOutput only. Time when transfer run was started. Parameter ignored by server for input requests.
formatgoogle-datetime
readOnlyTrue
typestring
state
descriptionData transfer run state. Ignored for input requests.
enum
  • TRANSFER_STATE_UNSPECIFIED
  • PENDING
  • RUNNING
  • SUCCEEDED
  • FAILED
  • CANCELLED
enumDescriptions
  • State placeholder (0).
  • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
  • Data transfer is in progress (3).
  • Data transfer completed successfully (4).
  • Data transfer failed (5).
  • Data transfer is cancelled (6).
typestring
subtaskOverallState
descriptionOverall state of subtasks belonging to the run. UNSPECIFIED means the transfer run doesn't have any subtask, SUCCEEDED means all subtasks succeeded, RUNNING means some subtasks are still running, and FAILED means some subtasks failed. Currently this should only be set when all the subtasks get into terminate state.
enum
  • STATE_UNSPECIFIED
  • RUNNING
  • SUCCEEDED
  • FAILED
enumDescriptions
  • Invalid or unspecified state.
  • Subtask is running.
  • Subtask succeeded.
  • Subtask failed.
typestring
tableFilters
descriptionTables that need to be loaded. If it's empty, then all tables will be loaded. Case insensitive.
items
typestring
typearray
updateTime
descriptionOutput only. Last time the data transfer run state was updated.
formatgoogle-datetime
readOnlyTrue
typestring
userId
descriptionDeprecated. Unique ID of the user on whose behalf transfer is done.
formatint64
typestring
typeobject
TransferRunBillingMeasurementEntry
descriptionA single measurement entry of resource usage for a transfer run.
idTransferRunBillingMeasurementEntry
properties
cloudNatBytes
descriptionRequired. volume of data processed by cloud nat this will be 0 if PSC Network Attachment was used
formatint64
typestring
cloudNatDuration
descriptionRequired. time spent using cloud NAT this will be 0 if PSC Network Attachment was used in nanoseconds
formatgoogle-duration
typestring
dts3pBorgDuration
descriptionRequired. transfer run execution time spent using DTS3P borg in nanoseconds
formatgoogle-duration
typestring
endTime
descriptionRequired. time at which billing measurements capture ended
formatgoogle-datetime
typestring
gcsBytes
descriptionRequired. volume of data stored in Cloud Storage for staging
formatint64
typestring
id
descriptionRequired. ID of the entry for deduplication
typestring
startTime
descriptionRequired. time at which billing measurements capture started
formatgoogle-datetime
typestring
ucsBorgDuration
descriptionRequired. transfer run execution time spent using UCS borg in nanoseconds
formatgoogle-duration
typestring
ucsGceDuration
descriptionRequired. transfer run execution time spent using Compute Engine VM in nanoseconds
formatgoogle-duration
typestring
typeobject
TransferRunSummary
descriptionSummary of the status of jobs started by a given run.
idTransferRunSummary
properties
bigqueryJobsCounts
$refJobCounts
descriptionThe counts for BigQuery jobs.
typeobject
TransferSubtask
descriptionRepresents a subtask for a particular data transfer run.
idTransferSubtask
properties
createTime
descriptionOutput only. The creation time for the subtask.
formatgoogle-datetime
readOnlyTrue
typestring
dataSourceId
descriptionOutput only. Data source id.
readOnlyTrue
typestring
dataVersion
descriptionData version for the subtask, which is interpreted by data source. Cannot be updated after creation.
typestring
datasetRegion
descriptionOutput only. Region in which BigQuery dataset is located.
readOnlyTrue
typestring
errorStatus
$refStatus
descriptionError code with more detailed information about reason of subtask failure. One of the values of google.rpc.Code enum: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto This value is set only after subtask is in one of the finalized states: SUCCEEDED or FAILED.
experiments
descriptionMendel experiment flags read by transfer run and passed to subtasks.
items
typestring
typearray
name
descriptionThe resource name of the transfer run subtask. The names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}/subtasks/{subtask_id}`. The name is ignored when creating a subtask.
typestring
originalAuthority
descriptionOutput only. OriginalAuthority of the user who created or updated the config. This will be used for auto-scheduled Transfer Runs. The security credentials library recommends storing this message as a blob. cs/symbol:security.credentials.OriginalAuthority
formatbyte
readOnlyTrue
typestring
retriable
descriptionSet to true if this subtask should be requeued to retry.
typeboolean
retryCount
descriptionNumber of previous retries processing this subtask.
formatint64
typestring
retryDelay
descriptionDelay for the retry.
formatgoogle-duration
typestring
runScheduleTime
descriptionOutput only. The schedule_time for the parent transfer run.
formatgoogle-datetime
readOnlyTrue
typestring
runTime
descriptionOutput only. The date and time that data should be ingested for the parent transfer run.
formatgoogle-datetime
readOnlyTrue
typestring
state
descriptionState of the subtask, which is updated by data sources.
enum
  • STATE_UNSPECIFIED
  • RUNNING
  • SUCCEEDED
  • FAILED
enumDescriptions
  • Invalid or unspecified state.
  • Subtask is running.
  • Subtask succeeded.
  • Subtask failed.
typestring
subtaskInfo
additionalProperties
descriptionProperties of the object.
typeany
descriptionThe details of the subtask, which is interpreted by data source only. For now task_info will be ignored when updating.
typeobject
subtaskResult
additionalProperties
descriptionProperties of the object.
typeany
descriptionResult of subtask, which is updated and interpreted by data source only.
typeobject
updateTime
descriptionOutput only. The modification time for the subtask.
formatgoogle-datetime
readOnlyTrue
typestring
userId
descriptionOutput only. The user id for this transfer run.
formatint64
readOnlyTrue
typestring
typeobject
TypeParameters
descriptionType Parameters for NUMERIC, STRING or BYTES types For NUMERIC types - Precision and Scale can be provided For STRING or BYTES - Max Length can be provided
idTypeParameters
properties
maxLength
descriptionIndicates the maximum length of string or bytes values
formatint64
typestring
precision
descriptionIndicates the precision of decimal values
formatint64
typestring
scale
descriptionIndicates the scale of decimal values
formatint64
typestring
typeobject
UnenrollDataSourcesRequest
descriptionA request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's `Transfer` tab.
idUnenrollDataSourcesRequest
properties
dataSourceIds
descriptionData sources that are unenrolled. It is required to provide at least one data source id.
items
typestring
typearray
typeobject
UserInfo
descriptionInformation about a user.
idUserInfo
properties
email
descriptionE-mail address of the user.
typestring
typeobject
ViewInfo
descriptionView creation/update related info.
idViewInfo
properties
skipCreateOrUpdateView
descriptionSkip creating or updating the view.
typeboolean
view
descriptionName of the view.
typestring
viewQuery
descriptionQuery used to create or update the view.
typestring
typeobject
iterable_item_removed
root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['resources']['runs']['resources']['transferLogs']['methods']['list']['parameters']['messageTypes']['enum'][4]DEBUG
root['resources']['projects']['resources']['locations']['resources']['transferConfigs']['resources']['runs']['resources']['transferLogs']['methods']['list']['parameters']['messageTypes']['enumDescriptions'][4]Debug message.
root['resources']['projects']['resources']['transferConfigs']['resources']['runs']['resources']['transferLogs']['methods']['list']['parameters']['messageTypes']['enum'][4]DEBUG
root['resources']['projects']['resources']['transferConfigs']['resources']['runs']['resources']['transferLogs']['methods']['list']['parameters']['messageTypes']['enumDescriptions'][4]Debug message.
sandbox/test-bigqueryreservation-
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/test-bigqueryreservation-v1
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/test-contentmanager-
values_changed
root['revision']
new_value20250220
old_value20250218
iterable_item_added
root['schemas']['ContactForm']['properties']['connectorType']['enum'][13]MOSP
root['schemas']['ContactForm']['properties']['connectorType']['enumDescriptions'][13]Submission via MOSP.
root['schemas']['Form']['properties']['submissionMechanism']['enum'][5]MOSP
root['schemas']['Form']['properties']['submissionMechanism']['enumDescriptions'][5]Submission through Menu of Services Platform API.
root['schemas']['FrdValues']['properties']['vrgUsageType']['enumDescriptions'][7]LINT.ThenChange( //depot/google3/java/com/google/support/kms/model/item/frd/VrgUsageType.java, //depot/google3/customer_support/kms/redwood/ui/client/model/item/frd/lib/taxonomy_frd_values_usage_type.dart )
root['schemas']['PropertyValue']['properties']['userProduct']['enum'][310]CASES_CUSTOMER_REALTIME
root['schemas']['PropertyValue']['properties']['userProduct']['enum'][419]ADVERTISER_IDENTITY_VERIFICATION
root['schemas']['PropertyValue']['properties']['userProduct']['enum'][420]LOCAL_SERVICES_ADS
root['schemas']['PropertyValue']['properties']['userProduct']['enumDescriptions'][310]Realtime signals for Customer accounts from both CDP and Ads F1. Keyed by customer ID.
root['schemas']['PropertyValue']['properties']['userProduct']['enumDescriptions'][420]Signals used for Local Services Ads
root['schemas']['ValidationIssueAssociatedVrgContext']['properties']['usageType']['enumDescriptions'][7]LINT.ThenChange( //depot/google3/java/com/google/support/kms/model/item/frd/VrgUsageType.java, //depot/google3/customer_support/kms/redwood/ui/client/model/item/frd/lib/taxonomy_frd_values_usage_type.dart )
sandbox/test-contentmanager-v1
values_changed
root['revision']
new_value20250220
old_value20250218
iterable_item_added
root['schemas']['ContactForm']['properties']['connectorType']['enum'][13]MOSP
root['schemas']['ContactForm']['properties']['connectorType']['enumDescriptions'][13]Submission via MOSP.
root['schemas']['Form']['properties']['submissionMechanism']['enum'][5]MOSP
root['schemas']['Form']['properties']['submissionMechanism']['enumDescriptions'][5]Submission through Menu of Services Platform API.
root['schemas']['FrdValues']['properties']['vrgUsageType']['enumDescriptions'][7]LINT.ThenChange( //depot/google3/java/com/google/support/kms/model/item/frd/VrgUsageType.java, //depot/google3/customer_support/kms/redwood/ui/client/model/item/frd/lib/taxonomy_frd_values_usage_type.dart )
root['schemas']['PropertyValue']['properties']['userProduct']['enum'][310]CASES_CUSTOMER_REALTIME
root['schemas']['PropertyValue']['properties']['userProduct']['enum'][419]ADVERTISER_IDENTITY_VERIFICATION
root['schemas']['PropertyValue']['properties']['userProduct']['enum'][420]LOCAL_SERVICES_ADS
root['schemas']['PropertyValue']['properties']['userProduct']['enumDescriptions'][310]Realtime signals for Customer accounts from both CDP and Ads F1. Keyed by customer ID.
root['schemas']['PropertyValue']['properties']['userProduct']['enumDescriptions'][420]Signals used for Local Services Ads
root['schemas']['ValidationIssueAssociatedVrgContext']['properties']['usageType']['enumDescriptions'][7]LINT.ThenChange( //depot/google3/java/com/google/support/kms/model/item/frd/VrgUsageType.java, //depot/google3/customer_support/kms/redwood/ui/client/model/item/frd/lib/taxonomy_frd_values_usage_type.dart )
sandbox/test-dataaccessauditlogging-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-dataaccessauditlogging-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-dialogflow-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/test-dialogflow-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/test-dialogflow-v2
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/test-dialogflow-v2beta1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/test-dialogflow-v3
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/test-dialogflow-v3alpha1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/test-dialogflow-v3beta1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/test-discoveryengine-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-discoveryengine-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-discoveryengine-v1alpha
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-discoveryengine-v1beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-firebaserules-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/test-firebaserules-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/test-language-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-language-eu-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-language-eu-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-language-eu-v1beta2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-language-eu-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-language-us-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-language-us-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-language-us-v1beta2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-language-us-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-language-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-language-v1beta2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-language-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-mlengine-pa-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-mlengine-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-monitoring-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-monitoring-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-monitoring-v3
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-recommendationengine-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-recommendationengine-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-recommendationengine-v1alpha
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-recommendationengine-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-redis-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-redis-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-redis-v1alpha1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-redis-v1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-redis-v1internal1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-retail-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-retail-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-retail-v2
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-retail-v2alpha
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-retail-v2beta
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-scone-pa-
values_changed
root['revision']
new_value20250220
old_value20250218
iterable_item_added
root['schemas']['CustomerSupportContentContactFlowModel']['properties']['contactFlowType']['enum'][13]MOSP
root['schemas']['CustomerSupportContentContactFlowModel']['properties']['contactFlowType']['enumDescriptions'][13]Submission via MOSP.
root['schemas']['CustomerSupportContentContactForm']['properties']['connectorType']['enum'][13]MOSP
root['schemas']['CustomerSupportContentContactForm']['properties']['connectorType']['enumDescriptions'][13]Submission via MOSP.
sandbox/test-scone-pa-v1
values_changed
root['revision']
new_value20250220
old_value20250218
iterable_item_added
root['schemas']['CustomerSupportContentContactFlowModel']['properties']['contactFlowType']['enum'][13]MOSP
root['schemas']['CustomerSupportContentContactFlowModel']['properties']['contactFlowType']['enumDescriptions'][13]Submission via MOSP.
root['schemas']['CustomerSupportContentContactForm']['properties']['connectorType']['enum'][13]MOSP
root['schemas']['CustomerSupportContentContactForm']['properties']['connectorType']['enumDescriptions'][13]Submission via MOSP.
sandbox/test-storagetransfer-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/test-storagetransfer-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/test-translate-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-translate-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-translate-v3
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-translate-v3alpha1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-translate-v3beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-translation-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-translation-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-translation-v3
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-translation-v3alpha1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-translation-v3beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-vision-
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-vision-v1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-vision-v1p1beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-vision-v1p2beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-vision-v1p3beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-vision-v1p4beta1
values_changed
root['revision']
new_value20250220
old_value20250219
sandbox/test-youtubereporting-
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/test-youtubereporting-v1
values_changed
root['revision']
new_value20250220
old_value20250218
sandbox/us-staging-vision-
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/us-staging-vision-v1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/us-staging-vision-v1p1beta1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/us-staging-vision-v1p2beta1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/us-staging-vision-v1p3beta1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218
sandbox/us-staging-vision-v1p4beta1
dictionary_item_added
  • root['schemas']['GoodocImage']['properties']['dpi']
values_changed
root['revision']
new_value20250219
old_value20250218