prod/abusereporting-pa-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/abusereporting-pa-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/abusiveexperiencereport-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/abusiveexperiencereport-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/acceleratedmobilepageurl-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/acceleratedmobilepageurl-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/accesscontextmanager-v1	values_changed root['revision'] new_value 20250206 old_value 20250129
prod/accesscontextmanager-v1alpha	values_changed root['revision'] new_value 20250206 old_value 20250129
prod/actions-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/actions-v2	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/actions-v2alpha	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/actions-v3	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/adexchangebuyer-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/adexchangebuyer-v2beta1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/adexperiencereport-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/adexperiencereport-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/admanager-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/admanager-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/admin-remotebuildexecution-	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/admin-remotebuildexecution-v1	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/admin-remotebuildexecution-v1alpha	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/admin-remotebuildexecution-v1test2	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/admin-remotebuildexecution-v2	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/adsdatahub-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/adsdatahub-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/adsense-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/adsense-v2	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/adsense-v2alpha	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/adsensehost-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/adsensehost-v4.1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/adsenseplatform-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/adsenseplatform-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/adsenseplatform-v1alpha	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/aerialview-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/aerialview-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/aerialview-v1beta	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/africa-south1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/africa-south1-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/airquality-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/airquality-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/alkalielea-pa-	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/alkalielea-pa-v1	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/analytics-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/analyticsadmin-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/analyticsadmin-v1alpha	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/analyticsadmin-v1beta	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/analyticsdata-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/analyticsdata-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/analyticsdata-v1alpha	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/analyticsdata-v1beta	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/androiddeviceprovisioning-	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/androiddeviceprovisioning-v1	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/androidmanagement-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/androidmanagement-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/androidovertheair-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/androidovertheair-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/androidpartner-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/androidpartner-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/androidpublisher-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/androidpublisher-v3	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/apigateway-	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/apigateway-v1alpha1	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/apigateway-v1beta	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/appengine-	values_changed root['revision'] new_value 20250131 old_value 20250127
prod/appengine-v1	values_changed root['revision'] new_value 20250131 old_value 20250127
prod/appengine-v1alpha	values_changed root['revision'] new_value 20250131 old_value 20250127
prod/appengine-v1beta	values_changed root['revision'] new_value 20250131 old_value 20250127
prod/apphub-	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/apphub-v1	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/apphub-v1alpha	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/arcore-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/arcore-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/arcore-v1beta2	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/arcorecloudanchor-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/arcorecloudanchor-v1beta2	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/area120tables-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/area120tables-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/areainsights-	values_changed root['revision'] new_value 20250206 old_value 20250203
prod/areainsights-v1	values_changed root['revision'] new_value 20250206 old_value 20250203
prod/artifactregistry-	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/artifactregistry-v1	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/artifactregistry-v1beta1	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/artifactregistry-v1beta2	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/asia-cloudkms-	values_changed root['revision'] new_value 20250203 old_value 20250124
prod/asia-east1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east1-aiplatform-	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['featureGroups']['resources']['featureMonitors']['methods']['patch'] root['schemas']['GoogleCloudAiplatformV1beta1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1RolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1DeployedModel']['properties']['rolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1beta1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1beta1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1beta1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/asia-east1-aiplatform-v1	dictionary_item_added root['schemas']['GoogleCloudAiplatformV1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/asia-east1-aiplatform-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/asia-east1-aiplatform-v1beta1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['featureGroups']['resources']['featureMonitors']['methods']['patch'] root['schemas']['GoogleCloudAiplatformV1beta1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1RolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1DeployedModel']['properties']['rolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1beta1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1beta1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1beta1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/asia-east1-assuredworkloads-	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/asia-east1-assuredworkloads-v1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/asia-east1-assuredworkloads-v1beta1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/asia-east1-cloudkms-	values_changed root['revision'] new_value 20250203 old_value 20250124
prod/asia-east1-datalineage-	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/asia-east1-datalineage-v1	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/asia-east1-dataproc-	values_changed root['revision'] new_value 20250122 old_value 20250131
prod/asia-east1-dataproc-v1	dictionary_item_removed root['schemas']['GceClusterConfig']['properties']['resourceManagerTags'] values_changed root['revision'] new_value 20250122 old_value 20250131
prod/asia-east1-dataproc-v1beta2	values_changed root['revision'] new_value 20250122 old_value 20250131
prod/asia-east1-iamcredentials-	values_changed root['revision'] new_value 20250130 old_value 20250122
prod/asia-east1-iamcredentials-v1	values_changed root['revision'] new_value 20250130 old_value 20250122
prod/asia-east1-integrations-	values_changed root['revision'] new_value 20250206 old_value 20250128
prod/asia-east1-integrations-v1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['integrations']['methods']['executeEvent']['parameters']['GCPCloudEventsMode'] root['schemas']['GoogleCloudConnectorsV1EnrichmentConfig'] root['schemas']['GoogleCloudConnectorsV1EventingConfig']['properties']['enrichmentConfig'] values_changed root['revision'] new_value 20250206 old_value 20250128
prod/asia-east1-logging-	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/asia-east1-logging-v2	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/asia-east1-run-	values_changed root['revision'] new_value 20250205 old_value 20250127 root['schemas']['GoogleCloudRunV2Container']['properties']['baseImageUri']['description'] new_value Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. old_value Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.
prod/asia-east1-run-v1	values_changed root['revision'] new_value 20250205 old_value 20250127
prod/asia-east1-run-v2	values_changed root['revision'] new_value 20250205 old_value 20250127 root['schemas']['GoogleCloudRunV2Container']['properties']['baseImageUri']['description'] new_value Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. old_value Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.
prod/asia-east2-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east2-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east2-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east2-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east2-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east2-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-east2-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast1-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast2-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast2-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast2-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast2-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast2-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast2-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast2-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast3-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast3-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast3-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast3-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast3-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast3-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-northeast3-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-cloudbuild-	values_changed root['resources']['projects']['resources']['locations']['resources']['connections']['methods']['processWebhook']['parameters']['webhookKey']['description'] new_value Arbitrary additional key to find the matching repository for a webhook event if needed. old_value Arbitrary additional key to find the maching repository for a webhook event if needed. root['revision'] new_value 20250129 old_value 20250117
prod/asia-south1-cloudbuild-v1	values_changed root['revision'] new_value 20250129 old_value 20250117
prod/asia-south1-cloudbuild-v2	values_changed root['resources']['projects']['resources']['locations']['resources']['connections']['methods']['processWebhook']['parameters']['webhookKey']['description'] new_value Arbitrary additional key to find the matching repository for a webhook event if needed. old_value Arbitrary additional key to find the maching repository for a webhook event if needed. root['revision'] new_value 20250129 old_value 20250117
prod/asia-south1-connectgateway-v1beta1	values_changed root['revision'] new_value 20250127 old_value 20250123
prod/asia-south1-containerfilesystem-	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/cloud-platform.read-only description View your data across Google Cloud services and see the email address of your Google Account https://www.googleapis.com/auth/devstorage.full_control description Manage your data and permissions in Cloud Storage and see the email address for your Google Account https://www.googleapis.com/auth/devstorage.read_only description View your data in Google Cloud Storage https://www.googleapis.com/auth/devstorage.read_write description Manage your data in Cloud Storage and see the email address of your Google Account basePath baseUrl https://containerfilesystem.googleapis.com/ batchPath batch canonicalName Container File System description Stream images stored in Artifact Registry to GKE discoveryVersion v1 documentationLink https://cloud.google.com/kubernetes-engine/docs/how-to/image-streaming fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id containerfilesystem:v1 kind discovery#restDescription mtlsRootUrl https://containerfilesystem.mtls.googleapis.com/ name containerfilesystem ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects methods auth description Authenticate the request for a given image name. Returns image id and access token. flatPath v1/projects/{projectsId}:auth httpMethod POST id containerfilesystem.projects.auth parameterOrder imageProject parameters imageProject description ID of the project hosting the image in the form of 'projects/my-project'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide (Cloud Riptide). location path pattern ^projects/[^/]+$ required True type string path v1/{+imageProject}:auth request $ref AuthImageRequest response $ref AuthImageReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write resources files methods readContent description Get file contents spanning a requested offset and length within a file. flatPath v1/projects/{projectsId}/files/{filesId} httpMethod GET id containerfilesystem.projects.files.readContent parameterOrder imageProject contentHash parameters accessToken description Access token used to verify access. Not used in GAE Riptide. location query type string contentHash description The SHA256 hexdigest of the file contents (uniquely identifies the file). location path pattern ^[^/]+$ required True type string decryptedContentHash description The SHA256 hexdigest of the decrypted file contents. If set, this means the content_hash field is the encrypted content hash. If the decrypted content is in fileserver caches, it will be returned instead of the encrypted content specified by the content_hash field. The client can determine which version was returned by inspecting the content_hash field of the reply. location query type string filePath description File path is optional unless auth is enabled. File path is used to optimize lookups if a given file is in the authorized layer from access token. location query type string fileSize description File size is optional, and is a hint to the file server, which can use the hint to speculate whether the file is a single-block file. format int64 location query type string imageId description Optional image ID where the file resides. Used only for prefetch list recording on fileserver-proxy for OnePlatform (GKE FUSE) clients. location query type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string length description The length to read. format int64 location query type string offset description The offset into the file from which to read. format int64 location query type string readSessionId description The id of the session (read-ahead/prefetch) that the current request belongs to. It takes the following forms: - "original_req_offset:original_req_length:read_ahead_size" for read ahead. location query type string retryAttempt description Retry attempt number. format int32 location query type integer type description Read type. Can be used by the backend for request handling and logging. enum DEFAULT READ_AHEAD PREFETCH enumDescriptions A regular content read. A read-ahead read (aka cache warming). A prefetching read. location query type string path v1/{+imageProject}/files/{+contentHash} response $ref ReadContentReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write layers methods get description Get the filesystem metadata for an individual layer of an image. flatPath v1/projects/{projectsId}/layers/{layersId} httpMethod GET id containerfilesystem.projects.layers.get parameterOrder imageProject layerId parameters accessToken description Access token used to verify access. Not used in GAE Riptide. location query type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string layerId description The layer ID, e.g. "sha256:abc...def" location path pattern ^[^/]+$ required True type string retryAttempt description Retry attempt number. format int32 location query type integer path v1/{+imageProject}/layers/{+layerId} response $ref LayerReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write prefetch methods get description Get the prefetch list bucket content of a specific image. flatPath v1/projects/{projectsId}/prefetch/{prefetchId} httpMethod GET id containerfilesystem.projects.prefetch.get parameterOrder imageProject filesystemId parameters accessToken description Serialized riptide.PrefetchAccessToken (from AuthImageReply.prefetch_token), encrypted with the server key and base64 encoded. This field is optional and set only if the API authentication is enabled. optional location query type string contextKey description Context key used to distinguish runs of the same image but with different parameters or arguments. location query type string filesystemId description The filesystem identifier, as defined in [MakeFileSystemID](http://google3/apphosting/sandbox/titanium/multi_container.cc?l=425&rcl=327218176). location path pattern ^[^/]+$ required True type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string path v1/{+imageProject}/prefetch/{+filesystemId} response $ref PrefetchImageReportReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write revision 20250125 rootUrl https://containerfilesystem.googleapis.com/ schemas APIBackoffConfig id APIBackoffConfig properties initialInterval description Initial duration for an RPC call retry policy. format google-duration type string maxDuration description Maximum duration for an RPC call retry policy. format google-duration type string maxRetries description Maximum number of retries for an RPC call. format uint64 type string multiplier description Exponential backoff multiplier for an RPC call retry policy. format double type number randomizationFactor description Randomization factor for an RPC call retry policy. format double type number type object AuthImageReply id AuthImageReply properties config $ref Config description The image config (env, port, cmd, ...) retrieved from Riptide Spanner. This will be useful for OnePlatform FUSE to populate the image config blob content as a FUSE file entry, so that `ctr run --rootfs ... --env ...` cmd can be easily executed, without having to perform a GET config blob req. imageId description Riptide image id (digest of the config file for docker schema 2) type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide (Cloud Riptide). Any subsequent RPC calls (GetLayer, ReadContent, GetPrefetchImageReport) should copy this value over to their corresponding request's image_project field. type string layers description A list of layers sorted by position, i.e. the first layer is the top-most layer of the image. The Layer proto also includes the encrypted LayerAccessToken which is required to access the respective layer and files within the layer. items $ref Layer type array prefetchToken description Encrypted and Base64 encoded prefetch token (PrefetchAccessToken protobuf message, serialized and encrypted with the server's key, which is not known to the client) type string serverParameters $ref ServerParameters description These parameters override the default const values or the values provided via command line flags. Parameter's 'scope' defines how it is pushed and how it is applied. The parameter scopes are defined as follows: - 'client' - applies to all features and RPCs of a particular client instance. These parameters are only honored when pushed in the reply of the initial AuthImage probe call. - 'image' - applies to features and RPC issued by particular client instance on the per-image basis.These parameters can be pushed in any AuthImage RPC reply. tokenExpirationTimeMs description Timestamp when the access token expires. format int64 type string type object AuthImageRequest id AuthImageRequest properties clientPlatform $ref ClientPlatform description Architecture and OS AuthImage uses to get the manifest from the manifest list. This is for multiplatform support. imageName description Full image name e.g. gcr.io/my-project/repo/image:tag or gcr.io/my-project/repo/image@digest type string pullSecret description Registry login credential ("(oauth2accesstoken|_json_key(_base64)?):.*") to support GKE imagePullSecrets (http://shortn/_V9ztR0xHVE). Allowed/ supported usernames/passwords are based on http://shortn/_9XF9GH1QIl. Uses RPC EUC if this field is empty. type string retryAttempt description Retry attempt number. format int32 type integer status description Status that indicates the current stage of image caching on GCFSD side. See go/riptide-authimage-heartbeat for more details. enum DEFAULT INITIAL REFRESH CACHED CACHE_DISABLED PROBE enumDescriptions Default value received from old clients that do not distinguish between different AuthImage types. First AuthImageRequest sent for image. Auth refresh heartbeat before image is fully cached. Image has been fully cached by client. The client has cache disabled. Initial server probing. type string type object ClientConfig id ClientConfig properties authImageBackoff $ref APIBackoffConfig description Backoff policy parameters for the AuthImage RPC. The max_duration field is ignored since AuthImage uses a constant backoff policy. policy. enableSingleFlighting description If set, enables/disables the single flighting for an image. type boolean getLayerBackoff $ref APIBackoffConfig description Backoff policy parameters for the GetLayer RPC. readAheadMaxBlocks description If set, enables/disables the read-ahead feature. format int64 type string readContentBackoff $ref APIBackoffConfig description Backoff policy parameters for the ReadContent RPC. type object ClientPlatform id ClientPlatform properties architecture description The architecture used to get the manifest from the manifest list. type string os description The OS used to get the manifest from the manifest list. type string type object Cmd description Defines the command that should be run in the container id Cmd properties args description The arguments to supply the executable items type string type array exec description The executable name (may be resolved with $PATH from Env) required type string type object Config description Configuration for a single container, extracted from the image manifest. This is going to be built with non_prod compatibility, so we should avoid putting any trade secrets in this proto. NEXT TAG: 13 id Config properties architecture description The architecture that the image is built for type string cmd $ref Cmd description The resolved command that should be run command description The CMD of a container. See https://docs.docker.com/engine/reference/builder/#cmd items type string type array dir description The working directory type string entrypoint description The ENTRYPOINT of a container. See https://docs.docker.com/engine/reference/builder/#entrypoint items type string type array env description The environment variables and values to set items $ref Env type array foundVarLog description The image has /var/log directory or not. If yes, the overlay (go/gvisor-overlay) can be configured to /var/log when Logging Fs is mounted at this dir. The overlay will auto-mount any subdirectories recursively under /var/log. type boolean image description The image ID type string labels description A set of labels recorded on the container. This is just raw data coming from the OCI container metadata. items $ref Label type array os description The OS that the image is built for type string port description The network ports to expose items $ref Port type array user description The user[:group] for the command (i.e. the Dockerfile USER, verbatim) type string type object Directory description A (complete) directory in a filesystem layer. id Directory properties entries description Files in this directory. items $ref Entry type array opaque description True if the directory should not be merged with lower layers. type boolean path description The full path to the directory, excluding the leading "/". For example, "/" is the empty string, and "/usr" is represented as "usr". type string type object Entry description A single directory entry in a filesystem layer. id Entry properties name description The name of the directory entry, relative to the directory path. type string stat $ref FileStat description The filesystem metadata for the directory entry. type object Env description Defines an environment variable id Env properties name description Environment variable name, e.g. "PATH" required type string value description Environment variable value, e.g. "/usr/bin:/usr/sbin" type string type object ExtendedAttribute description File extended attributes entry. id ExtendedAttribute properties name type string value format byte type string type object FileBlock description A block of a file in the Riptide filesystem. id FileBlock properties blockData description The block contents. format byte type string blockHash description The SHA256 hexdigest of the block contents. type string lastBlock description Whether the block is the last block in the file. type boolean lowerBound description The lower bound (offset) of the block within the file. Inclusive. format int64 type string upperBound description The upper bound (offset+limit) of the block within the file. Exclusive: the block_data contains the range [lower_bound, upper_bound). format int64 type string type object FileStat description Riptide filesystem metadata for a file. LINT.IfChange id FileStat properties contentHash description SHA256 hexdigest of file contents. type string extendedAttributes description File extended attributes. More info at go/riptide-linux-xattr-support. This may not be populated for the images that do not have xattr support yet. TODO (b/204105260): Change the comment once all the images in Spanner are re-imported with xattr support. items $ref ExtendedAttribute type array gid description GID of file owner. format int32 type integer inlined description Whether the file came from an InlineLayer overlay. type boolean link description Link target (for hard and soft links). type string mode description Linux mode and permission bits. format uint32 type integer mtime description File modification timestamp (microseconds since Unix epoch). format int64 type string size description File size in bytes. format int64 type string uid description UID of file owner. format int32 type integer whiteout description Whether the file is a whiteout. type boolean type object ImageConfig id ImageConfig properties enablePrefetching description If set, enables/disables prefetching for an image. type boolean type object Label description Label is a simple key-value pair. id Label properties key type string value type string type object Layer description Describes a Docker image layer. id Layer properties bytesImported description compared with `layer_info.raw_bytes` to see progress, and can be used in combination with `import_start_time_usec` and the current timestamp to estimate the speed of the layer import. format int64 type string decryptedId description The decrypted layer ID. Populated only if `project_encryption_key_id` is non-empty. type string diffId description The Docker Diff ID (SHA256 digest of the layer tar). V2 schema only. type string digest description The SHA256 digest of the gzip'd layer tar. type string id description The layer ID. If from a v1 schema, this is the digest of the gzip contents. If from a v2 schema, this is the Docker Diff ID. For layers encrypted with a CMEK key, this ID is also encrypted, and `decrypted_id` contains the original layer ID. required type string importFinishTimeUsec description Unix timestamp (in micros) when the layer import completed, or 0 if the import has not completed. format int64 type string importStartTimeUsec description Unix timestamp (in micros) when the layer import started. format int64 type string lastActiveTimeUsec description The last active timestamp of the layer download from Layers.Task if the Layers.Status is not READY, and taken from ProjectLayers.Task otherwise. This determines if we need to restart the download or verification of a layer. format int64 type string layerAccessToken description Encrypted and Base64 encoded Riptide layer access token (LayerAccessToken protobuf message, serialized and encrypted with the server's key, which is not known to the client) type string layerInfo $ref LayerInfo description Various metatadata characterizing the size and contents, and other aspects of the layer. layerStatus description The status taken directly from Layers.Status. This may be READY even if `status` is not. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string mediaType description Layer media type. Empty for image manifest schema 1. type string projectEncryptionKeyId description Project encryption key ID for CMEK. If empty, the layer is not encrypted with a customer managed encryption key. type string projectLayerStatus description The status taken from ProjectLayers.Status. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string provenance description The layer provenance - where this layer came from (if known). enum PROVENANCE_UNKNOWN PROVENANCE_USER PROVENANCE_GOOGLE enumDescriptions Layer provenance is not known. Layer contains user code. Layer was provided by Google, e.g. in a base image. type string status description The status of the layer import (from Layers, or from ProjectLayers if the Layers.Status is READY). If this is READY, the layer is ready for use in the project. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string type object LayerInfo description Various metatadata characterizing the size and contents, and other aspects of a filesystem layer. id LayerInfo properties aiMlMarkers description Markers in the layer that categorize it as an AI/ML layer. items enum UNSPECIFIED CUDA TENSORFLOW enumDescriptions The layer contains CUDA libraries. The layer contains Tensorflow libraries. type string type array directories description The number of directories (both empty and non-empty) in the layer. format uint32 type integer entries description The number of entries in the layer's tar archive. Includes all directories, files, and whiteouts. format uint32 type integer fileBytes description The total number of bytes in all regular files in the layer. format int64 type string filePathSignature description A signature computed by XOR-ing the fingerprint2011 hashes of the file paths of regular files in the layer. format uint64 type string files description The number of regular files (empty and non-empty) in the layer. format uint32 type integer hardLinks description The number of hard links in the layer. format uint32 type integer rawBytes description The number of bytes in the raw (likely gzip compressed) layer blob that was downloaded from the registry at layer import time. format int64 type string softLinks description The number of soft links in the layer. format uint32 type integer tarBytes description The number of bytes in the layer's uncompressed tar archive. format int64 type string whiteouts description The number of whiteouts in the layer. The .wh..wh..opq file (which marks a directory as opaque) is counted as a whiteout (along with any whiteout files with paths like /path/to/.wh.). format uint32 type integer type object LayerReply description RPC response to the request for a Riptide layer. id LayerReply properties directories description The complete list of directories in this layer. items $ref Directory type array projectKeyId description The project key (DEK) identifier, if the layer is encrypted with CMEK. type string type object Port description Defines a TCP or UDP port by protocol and number id Port properties containerPort description The port number within the container's net namespace (0-65535) required format int32 type integer hostPort description The port number outside of the net namespace (if any) (0-65535) format int32 type integer protocol description The protocol (TCP or UDP) required enum PROTO_NONE PROTO_TCP PROTO_UDP enumDescriptions Unknown TCP UDP type string type object PrefetchFileReport description PrefetchFileReport contains one or more reads within the same file. Each read is associated to a file using its file identifier. This allow the server to be able to authorize the client access to the file. id PrefetchFileReport properties fileId description Field used to uniquely identify a file. If the layer_access_token for the layer is set it means that the authentication is enabled; if so the file_id will be the riptide.FileIdentifier encrypted with the layer_encryption key and base64-encoded (more details at go/riptide-auth-design). If the authentication is not enabled this instead will be the file content_hash. type string filePosition description Position within the merged prefetch list of reads executed by the application. format int32 type integer fileSize description File size, as reported by the prefetch recorder based on the SandboxFS. format int64 type string offsets description List of offsets read within the file. Note that reads are aligned at 1MB block sizes. If the list of offsets is empty indicates that the read covers the whole file. items format int64 type string type array type object PrefetchImageReport description LINT.IfChange id PrefetchImageReport properties contextKey description Context key used to distinguish runs of the same image but with different parameters or arguments. type string creationTimestampMicros description Timestamp creation of this report. format int64 type string filesystemId description The filesystem identifier, as defined in [MakeFileSystemID](http://google3/apphosting/sandbox/titanium/multi_container.cc?l=425&rcl=327218176). type string generation description Initially set to 0 indicates that the report is partial. Values greater than 0 indicates a complete report. For more details about how the value changes as a result of a merge process, please refer to the merge logic at http://google3/cloud/containers/riptide/prefetch/prefetch_list_merge.cc. format int64 type string layers description The list of block reads within a layer issued by the container. items $ref PrefetchLayerReport type array version description This field allows to distinguish between different versions of the prefetch list code. This enables the possibility to change the logic and eventually take actions on old reports generated by the previous logic. Set this value to the cl number that changes the logic. The current value is defined in the Recorder library http://google3/cloud/containers/riptide/prefetch/recorder.cc. format int64 type string type object PrefetchImageReportReply description RPC reply for the GetPrefetchImageReport. id PrefetchImageReportReply properties imageReport $ref PrefetchImageReport description The image report requested. type object PrefetchLayerReport id PrefetchLayerReport properties files description List of file reads issued by the client within this layer. items $ref PrefetchFileReport type array layerId description The layer id. type string type object ReadContentReply description RPC response to the request to read from a file in Riptide. id ReadContentReply properties blocks description File blocks that cover the requested offset and length. items $ref FileBlock type array contentHash description The SHA256 hexdigest of the returned file. This can be used to distinguish whether the fileserver was able to return the decrypted version of the requested encrypted content. type string type object ServerParameters id ServerParameters properties clientConfig $ref ClientConfig description ClientConfig is the configuration for all RPCs/features of a particular client instance. It should be set only once and then it stays immutable. imageConfig $ref ImageConfig description ImageConfig is the configuration for customizing features/RPC behavior on per image basis. type object servicePath title Container File System API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/asia-south1-containerfilesystem-v1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/cloud-platform.read-only description View your data across Google Cloud services and see the email address of your Google Account https://www.googleapis.com/auth/devstorage.full_control description Manage your data and permissions in Cloud Storage and see the email address for your Google Account https://www.googleapis.com/auth/devstorage.read_only description View your data in Google Cloud Storage https://www.googleapis.com/auth/devstorage.read_write description Manage your data in Cloud Storage and see the email address of your Google Account basePath baseUrl https://containerfilesystem.googleapis.com/ batchPath batch canonicalName Container File System description Stream images stored in Artifact Registry to GKE discoveryVersion v1 documentationLink https://cloud.google.com/kubernetes-engine/docs/how-to/image-streaming fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id containerfilesystem:v1 kind discovery#restDescription mtlsRootUrl https://containerfilesystem.mtls.googleapis.com/ name containerfilesystem ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects methods auth description Authenticate the request for a given image name. Returns image id and access token. flatPath v1/projects/{projectsId}:auth httpMethod POST id containerfilesystem.projects.auth parameterOrder imageProject parameters imageProject description ID of the project hosting the image in the form of 'projects/my-project'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide (Cloud Riptide). location path pattern ^projects/[^/]+$ required True type string path v1/{+imageProject}:auth request $ref AuthImageRequest response $ref AuthImageReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write resources files methods readContent description Get file contents spanning a requested offset and length within a file. flatPath v1/projects/{projectsId}/files/{filesId} httpMethod GET id containerfilesystem.projects.files.readContent parameterOrder imageProject contentHash parameters accessToken description Access token used to verify access. Not used in GAE Riptide. location query type string contentHash description The SHA256 hexdigest of the file contents (uniquely identifies the file). location path pattern ^[^/]+$ required True type string decryptedContentHash description The SHA256 hexdigest of the decrypted file contents. If set, this means the content_hash field is the encrypted content hash. If the decrypted content is in fileserver caches, it will be returned instead of the encrypted content specified by the content_hash field. The client can determine which version was returned by inspecting the content_hash field of the reply. location query type string filePath description File path is optional unless auth is enabled. File path is used to optimize lookups if a given file is in the authorized layer from access token. location query type string fileSize description File size is optional, and is a hint to the file server, which can use the hint to speculate whether the file is a single-block file. format int64 location query type string imageId description Optional image ID where the file resides. Used only for prefetch list recording on fileserver-proxy for OnePlatform (GKE FUSE) clients. location query type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string length description The length to read. format int64 location query type string offset description The offset into the file from which to read. format int64 location query type string readSessionId description The id of the session (read-ahead/prefetch) that the current request belongs to. It takes the following forms: - "original_req_offset:original_req_length:read_ahead_size" for read ahead. location query type string retryAttempt description Retry attempt number. format int32 location query type integer type description Read type. Can be used by the backend for request handling and logging. enum DEFAULT READ_AHEAD PREFETCH enumDescriptions A regular content read. A read-ahead read (aka cache warming). A prefetching read. location query type string path v1/{+imageProject}/files/{+contentHash} response $ref ReadContentReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write layers methods get description Get the filesystem metadata for an individual layer of an image. flatPath v1/projects/{projectsId}/layers/{layersId} httpMethod GET id containerfilesystem.projects.layers.get parameterOrder imageProject layerId parameters accessToken description Access token used to verify access. Not used in GAE Riptide. location query type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string layerId description The layer ID, e.g. "sha256:abc...def" location path pattern ^[^/]+$ required True type string retryAttempt description Retry attempt number. format int32 location query type integer path v1/{+imageProject}/layers/{+layerId} response $ref LayerReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write prefetch methods get description Get the prefetch list bucket content of a specific image. flatPath v1/projects/{projectsId}/prefetch/{prefetchId} httpMethod GET id containerfilesystem.projects.prefetch.get parameterOrder imageProject filesystemId parameters accessToken description Serialized riptide.PrefetchAccessToken (from AuthImageReply.prefetch_token), encrypted with the server key and base64 encoded. This field is optional and set only if the API authentication is enabled. optional location query type string contextKey description Context key used to distinguish runs of the same image but with different parameters or arguments. location query type string filesystemId description The filesystem identifier, as defined in [MakeFileSystemID](http://google3/apphosting/sandbox/titanium/multi_container.cc?l=425&rcl=327218176). location path pattern ^[^/]+$ required True type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string path v1/{+imageProject}/prefetch/{+filesystemId} response $ref PrefetchImageReportReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write revision 20250125 rootUrl https://containerfilesystem.googleapis.com/ schemas APIBackoffConfig id APIBackoffConfig properties initialInterval description Initial duration for an RPC call retry policy. format google-duration type string maxDuration description Maximum duration for an RPC call retry policy. format google-duration type string maxRetries description Maximum number of retries for an RPC call. format uint64 type string multiplier description Exponential backoff multiplier for an RPC call retry policy. format double type number randomizationFactor description Randomization factor for an RPC call retry policy. format double type number type object AuthImageReply id AuthImageReply properties config $ref Config description The image config (env, port, cmd, ...) retrieved from Riptide Spanner. This will be useful for OnePlatform FUSE to populate the image config blob content as a FUSE file entry, so that `ctr run --rootfs ... --env ...` cmd can be easily executed, without having to perform a GET config blob req. imageId description Riptide image id (digest of the config file for docker schema 2) type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide (Cloud Riptide). Any subsequent RPC calls (GetLayer, ReadContent, GetPrefetchImageReport) should copy this value over to their corresponding request's image_project field. type string layers description A list of layers sorted by position, i.e. the first layer is the top-most layer of the image. The Layer proto also includes the encrypted LayerAccessToken which is required to access the respective layer and files within the layer. items $ref Layer type array prefetchToken description Encrypted and Base64 encoded prefetch token (PrefetchAccessToken protobuf message, serialized and encrypted with the server's key, which is not known to the client) type string serverParameters $ref ServerParameters description These parameters override the default const values or the values provided via command line flags. Parameter's 'scope' defines how it is pushed and how it is applied. The parameter scopes are defined as follows: - 'client' - applies to all features and RPCs of a particular client instance. These parameters are only honored when pushed in the reply of the initial AuthImage probe call. - 'image' - applies to features and RPC issued by particular client instance on the per-image basis.These parameters can be pushed in any AuthImage RPC reply. tokenExpirationTimeMs description Timestamp when the access token expires. format int64 type string type object AuthImageRequest id AuthImageRequest properties clientPlatform $ref ClientPlatform description Architecture and OS AuthImage uses to get the manifest from the manifest list. This is for multiplatform support. imageName description Full image name e.g. gcr.io/my-project/repo/image:tag or gcr.io/my-project/repo/image@digest type string pullSecret description Registry login credential ("(oauth2accesstoken|_json_key(_base64)?):.*") to support GKE imagePullSecrets (http://shortn/_V9ztR0xHVE). Allowed/ supported usernames/passwords are based on http://shortn/_9XF9GH1QIl. Uses RPC EUC if this field is empty. type string retryAttempt description Retry attempt number. format int32 type integer status description Status that indicates the current stage of image caching on GCFSD side. See go/riptide-authimage-heartbeat for more details. enum DEFAULT INITIAL REFRESH CACHED CACHE_DISABLED PROBE enumDescriptions Default value received from old clients that do not distinguish between different AuthImage types. First AuthImageRequest sent for image. Auth refresh heartbeat before image is fully cached. Image has been fully cached by client. The client has cache disabled. Initial server probing. type string type object ClientConfig id ClientConfig properties authImageBackoff $ref APIBackoffConfig description Backoff policy parameters for the AuthImage RPC. The max_duration field is ignored since AuthImage uses a constant backoff policy. policy. enableSingleFlighting description If set, enables/disables the single flighting for an image. type boolean getLayerBackoff $ref APIBackoffConfig description Backoff policy parameters for the GetLayer RPC. readAheadMaxBlocks description If set, enables/disables the read-ahead feature. format int64 type string readContentBackoff $ref APIBackoffConfig description Backoff policy parameters for the ReadContent RPC. type object ClientPlatform id ClientPlatform properties architecture description The architecture used to get the manifest from the manifest list. type string os description The OS used to get the manifest from the manifest list. type string type object Cmd description Defines the command that should be run in the container id Cmd properties args description The arguments to supply the executable items type string type array exec description The executable name (may be resolved with $PATH from Env) required type string type object Config description Configuration for a single container, extracted from the image manifest. This is going to be built with non_prod compatibility, so we should avoid putting any trade secrets in this proto. NEXT TAG: 13 id Config properties architecture description The architecture that the image is built for type string cmd $ref Cmd description The resolved command that should be run command description The CMD of a container. See https://docs.docker.com/engine/reference/builder/#cmd items type string type array dir description The working directory type string entrypoint description The ENTRYPOINT of a container. See https://docs.docker.com/engine/reference/builder/#entrypoint items type string type array env description The environment variables and values to set items $ref Env type array foundVarLog description The image has /var/log directory or not. If yes, the overlay (go/gvisor-overlay) can be configured to /var/log when Logging Fs is mounted at this dir. The overlay will auto-mount any subdirectories recursively under /var/log. type boolean image description The image ID type string labels description A set of labels recorded on the container. This is just raw data coming from the OCI container metadata. items $ref Label type array os description The OS that the image is built for type string port description The network ports to expose items $ref Port type array user description The user[:group] for the command (i.e. the Dockerfile USER, verbatim) type string type object Directory description A (complete) directory in a filesystem layer. id Directory properties entries description Files in this directory. items $ref Entry type array opaque description True if the directory should not be merged with lower layers. type boolean path description The full path to the directory, excluding the leading "/". For example, "/" is the empty string, and "/usr" is represented as "usr". type string type object Entry description A single directory entry in a filesystem layer. id Entry properties name description The name of the directory entry, relative to the directory path. type string stat $ref FileStat description The filesystem metadata for the directory entry. type object Env description Defines an environment variable id Env properties name description Environment variable name, e.g. "PATH" required type string value description Environment variable value, e.g. "/usr/bin:/usr/sbin" type string type object ExtendedAttribute description File extended attributes entry. id ExtendedAttribute properties name type string value format byte type string type object FileBlock description A block of a file in the Riptide filesystem. id FileBlock properties blockData description The block contents. format byte type string blockHash description The SHA256 hexdigest of the block contents. type string lastBlock description Whether the block is the last block in the file. type boolean lowerBound description The lower bound (offset) of the block within the file. Inclusive. format int64 type string upperBound description The upper bound (offset+limit) of the block within the file. Exclusive: the block_data contains the range [lower_bound, upper_bound). format int64 type string type object FileStat description Riptide filesystem metadata for a file. LINT.IfChange id FileStat properties contentHash description SHA256 hexdigest of file contents. type string extendedAttributes description File extended attributes. More info at go/riptide-linux-xattr-support. This may not be populated for the images that do not have xattr support yet. TODO (b/204105260): Change the comment once all the images in Spanner are re-imported with xattr support. items $ref ExtendedAttribute type array gid description GID of file owner. format int32 type integer inlined description Whether the file came from an InlineLayer overlay. type boolean link description Link target (for hard and soft links). type string mode description Linux mode and permission bits. format uint32 type integer mtime description File modification timestamp (microseconds since Unix epoch). format int64 type string size description File size in bytes. format int64 type string uid description UID of file owner. format int32 type integer whiteout description Whether the file is a whiteout. type boolean type object ImageConfig id ImageConfig properties enablePrefetching description If set, enables/disables prefetching for an image. type boolean type object Label description Label is a simple key-value pair. id Label properties key type string value type string type object Layer description Describes a Docker image layer. id Layer properties bytesImported description compared with `layer_info.raw_bytes` to see progress, and can be used in combination with `import_start_time_usec` and the current timestamp to estimate the speed of the layer import. format int64 type string decryptedId description The decrypted layer ID. Populated only if `project_encryption_key_id` is non-empty. type string diffId description The Docker Diff ID (SHA256 digest of the layer tar). V2 schema only. type string digest description The SHA256 digest of the gzip'd layer tar. type string id description The layer ID. If from a v1 schema, this is the digest of the gzip contents. If from a v2 schema, this is the Docker Diff ID. For layers encrypted with a CMEK key, this ID is also encrypted, and `decrypted_id` contains the original layer ID. required type string importFinishTimeUsec description Unix timestamp (in micros) when the layer import completed, or 0 if the import has not completed. format int64 type string importStartTimeUsec description Unix timestamp (in micros) when the layer import started. format int64 type string lastActiveTimeUsec description The last active timestamp of the layer download from Layers.Task if the Layers.Status is not READY, and taken from ProjectLayers.Task otherwise. This determines if we need to restart the download or verification of a layer. format int64 type string layerAccessToken description Encrypted and Base64 encoded Riptide layer access token (LayerAccessToken protobuf message, serialized and encrypted with the server's key, which is not known to the client) type string layerInfo $ref LayerInfo description Various metatadata characterizing the size and contents, and other aspects of the layer. layerStatus description The status taken directly from Layers.Status. This may be READY even if `status` is not. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string mediaType description Layer media type. Empty for image manifest schema 1. type string projectEncryptionKeyId description Project encryption key ID for CMEK. If empty, the layer is not encrypted with a customer managed encryption key. type string projectLayerStatus description The status taken from ProjectLayers.Status. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string provenance description The layer provenance - where this layer came from (if known). enum PROVENANCE_UNKNOWN PROVENANCE_USER PROVENANCE_GOOGLE enumDescriptions Layer provenance is not known. Layer contains user code. Layer was provided by Google, e.g. in a base image. type string status description The status of the layer import (from Layers, or from ProjectLayers if the Layers.Status is READY). If this is READY, the layer is ready for use in the project. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string type object LayerInfo description Various metatadata characterizing the size and contents, and other aspects of a filesystem layer. id LayerInfo properties aiMlMarkers description Markers in the layer that categorize it as an AI/ML layer. items enum UNSPECIFIED CUDA TENSORFLOW enumDescriptions The layer contains CUDA libraries. The layer contains Tensorflow libraries. type string type array directories description The number of directories (both empty and non-empty) in the layer. format uint32 type integer entries description The number of entries in the layer's tar archive. Includes all directories, files, and whiteouts. format uint32 type integer fileBytes description The total number of bytes in all regular files in the layer. format int64 type string filePathSignature description A signature computed by XOR-ing the fingerprint2011 hashes of the file paths of regular files in the layer. format uint64 type string files description The number of regular files (empty and non-empty) in the layer. format uint32 type integer hardLinks description The number of hard links in the layer. format uint32 type integer rawBytes description The number of bytes in the raw (likely gzip compressed) layer blob that was downloaded from the registry at layer import time. format int64 type string softLinks description The number of soft links in the layer. format uint32 type integer tarBytes description The number of bytes in the layer's uncompressed tar archive. format int64 type string whiteouts description The number of whiteouts in the layer. The .wh..wh..opq file (which marks a directory as opaque) is counted as a whiteout (along with any whiteout files with paths like /path/to/.wh.). format uint32 type integer type object LayerReply description RPC response to the request for a Riptide layer. id LayerReply properties directories description The complete list of directories in this layer. items $ref Directory type array projectKeyId description The project key (DEK) identifier, if the layer is encrypted with CMEK. type string type object Port description Defines a TCP or UDP port by protocol and number id Port properties containerPort description The port number within the container's net namespace (0-65535) required format int32 type integer hostPort description The port number outside of the net namespace (if any) (0-65535) format int32 type integer protocol description The protocol (TCP or UDP) required enum PROTO_NONE PROTO_TCP PROTO_UDP enumDescriptions Unknown TCP UDP type string type object PrefetchFileReport description PrefetchFileReport contains one or more reads within the same file. Each read is associated to a file using its file identifier. This allow the server to be able to authorize the client access to the file. id PrefetchFileReport properties fileId description Field used to uniquely identify a file. If the layer_access_token for the layer is set it means that the authentication is enabled; if so the file_id will be the riptide.FileIdentifier encrypted with the layer_encryption key and base64-encoded (more details at go/riptide-auth-design). If the authentication is not enabled this instead will be the file content_hash. type string filePosition description Position within the merged prefetch list of reads executed by the application. format int32 type integer fileSize description File size, as reported by the prefetch recorder based on the SandboxFS. format int64 type string offsets description List of offsets read within the file. Note that reads are aligned at 1MB block sizes. If the list of offsets is empty indicates that the read covers the whole file. items format int64 type string type array type object PrefetchImageReport description LINT.IfChange id PrefetchImageReport properties contextKey description Context key used to distinguish runs of the same image but with different parameters or arguments. type string creationTimestampMicros description Timestamp creation of this report. format int64 type string filesystemId description The filesystem identifier, as defined in [MakeFileSystemID](http://google3/apphosting/sandbox/titanium/multi_container.cc?l=425&rcl=327218176). type string generation description Initially set to 0 indicates that the report is partial. Values greater than 0 indicates a complete report. For more details about how the value changes as a result of a merge process, please refer to the merge logic at http://google3/cloud/containers/riptide/prefetch/prefetch_list_merge.cc. format int64 type string layers description The list of block reads within a layer issued by the container. items $ref PrefetchLayerReport type array version description This field allows to distinguish between different versions of the prefetch list code. This enables the possibility to change the logic and eventually take actions on old reports generated by the previous logic. Set this value to the cl number that changes the logic. The current value is defined in the Recorder library http://google3/cloud/containers/riptide/prefetch/recorder.cc. format int64 type string type object PrefetchImageReportReply description RPC reply for the GetPrefetchImageReport. id PrefetchImageReportReply properties imageReport $ref PrefetchImageReport description The image report requested. type object PrefetchLayerReport id PrefetchLayerReport properties files description List of file reads issued by the client within this layer. items $ref PrefetchFileReport type array layerId description The layer id. type string type object ReadContentReply description RPC response to the request to read from a file in Riptide. id ReadContentReply properties blocks description File blocks that cover the requested offset and length. items $ref FileBlock type array contentHash description The SHA256 hexdigest of the returned file. This can be used to distinguish whether the fileserver was able to return the decrypted version of the requested encrypted content. type string type object ServerParameters id ServerParameters properties clientConfig $ref ClientConfig description ClientConfig is the configuration for all RPCs/features of a particular client instance. It should be set only once and then it stays immutable. imageConfig $ref ImageConfig description ImageConfig is the configuration for customizing features/RPC behavior on per image basis. type object servicePath title Container File System API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/asia-south1-dataproc-	values_changed root['revision'] new_value 20250122 old_value 20250131
prod/asia-south1-dataproc-v1	dictionary_item_removed root['schemas']['GceClusterConfig']['properties']['resourceManagerTags'] values_changed root['revision'] new_value 20250122 old_value 20250131
prod/asia-south1-dataproc-v1beta2	values_changed root['revision'] new_value 20250122 old_value 20250131
prod/asia-south1-gkemulticloud-	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/asia-south1-gkemulticloud-v1	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/asia-south1-healthcare-	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['methods']['retrieveRendered']['parameters']['viewport'] root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['resources']['frames']['methods']['retrieveRendered']['parameters']['viewport'] values_changed root['revision'] new_value 20250129 old_value 20250127
prod/asia-south1-healthcare-v1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['methods']['retrieveRendered']['parameters']['viewport'] root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['resources']['frames']['methods']['retrieveRendered']['parameters']['viewport'] values_changed root['revision'] new_value 20250129 old_value 20250127
prod/asia-south1-healthcare-v1alpha2	values_changed root['revision'] new_value 20250129 old_value 20250127
prod/asia-south1-healthcare-v1beta1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['methods']['retrieveRendered']['parameters']['viewport'] root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['resources']['frames']['methods']['retrieveRendered']['parameters']['viewport'] values_changed root['revision'] new_value 20250129 old_value 20250127
prod/asia-south1-pubsub-	values_changed root['revision'] new_value 20250128 old_value 20250123
prod/asia-south1-pubsub-v1	dictionary_item_added root['schemas']['JavaScriptUDF'] root['schemas']['MessageTransform'] root['schemas']['Subscription']['properties']['messageTransforms'] root['schemas']['Topic']['properties']['messageTransforms'] values_changed root['revision'] new_value 20250128 old_value 20250123
prod/asia-south1-pubsub-v1beta2	values_changed root['revision'] new_value 20250128 old_value 20250123
prod/asia-south1-speech-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-speech-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-speech-v1p1beta1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-speech-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south1-workflowexecutions-	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/asia-south1-workflowexecutions-v1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/asia-south1-workflowexecutions-v1alpha1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/asia-south1-workflowexecutions-v1beta	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/asia-south2-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-south2-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-artifactregistry-v1	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/asia-southeast1-artifactregistry-v1beta1	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/asia-southeast1-artifactregistry-v1beta2	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/asia-southeast1-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast1-chronicle-v1beta	values_changed root['revision'] new_value 20250130 old_value 20250124
prod/asia-southeast1-connectgateway-	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/asia-southeast1-connectgateway-v1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/asia-southeast1-connectgateway-v1beta1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/asia-southeast1-containerfilesystem-	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/cloud-platform.read-only description View your data across Google Cloud services and see the email address of your Google Account https://www.googleapis.com/auth/devstorage.full_control description Manage your data and permissions in Cloud Storage and see the email address for your Google Account https://www.googleapis.com/auth/devstorage.read_only description View your data in Google Cloud Storage https://www.googleapis.com/auth/devstorage.read_write description Manage your data in Cloud Storage and see the email address of your Google Account basePath baseUrl https://containerfilesystem.googleapis.com/ batchPath batch canonicalName Container File System description Stream images stored in Artifact Registry to GKE discoveryVersion v1 documentationLink https://cloud.google.com/kubernetes-engine/docs/how-to/image-streaming fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id containerfilesystem:v1 kind discovery#restDescription mtlsRootUrl https://containerfilesystem.mtls.googleapis.com/ name containerfilesystem ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects methods auth description Authenticate the request for a given image name. Returns image id and access token. flatPath v1/projects/{projectsId}:auth httpMethod POST id containerfilesystem.projects.auth parameterOrder imageProject parameters imageProject description ID of the project hosting the image in the form of 'projects/my-project'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide (Cloud Riptide). location path pattern ^projects/[^/]+$ required True type string path v1/{+imageProject}:auth request $ref AuthImageRequest response $ref AuthImageReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write resources files methods readContent description Get file contents spanning a requested offset and length within a file. flatPath v1/projects/{projectsId}/files/{filesId} httpMethod GET id containerfilesystem.projects.files.readContent parameterOrder imageProject contentHash parameters accessToken description Access token used to verify access. Not used in GAE Riptide. location query type string contentHash description The SHA256 hexdigest of the file contents (uniquely identifies the file). location path pattern ^[^/]+$ required True type string decryptedContentHash description The SHA256 hexdigest of the decrypted file contents. If set, this means the content_hash field is the encrypted content hash. If the decrypted content is in fileserver caches, it will be returned instead of the encrypted content specified by the content_hash field. The client can determine which version was returned by inspecting the content_hash field of the reply. location query type string filePath description File path is optional unless auth is enabled. File path is used to optimize lookups if a given file is in the authorized layer from access token. location query type string fileSize description File size is optional, and is a hint to the file server, which can use the hint to speculate whether the file is a single-block file. format int64 location query type string imageId description Optional image ID where the file resides. Used only for prefetch list recording on fileserver-proxy for OnePlatform (GKE FUSE) clients. location query type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string length description The length to read. format int64 location query type string offset description The offset into the file from which to read. format int64 location query type string readSessionId description The id of the session (read-ahead/prefetch) that the current request belongs to. It takes the following forms: - "original_req_offset:original_req_length:read_ahead_size" for read ahead. location query type string retryAttempt description Retry attempt number. format int32 location query type integer type description Read type. Can be used by the backend for request handling and logging. enum DEFAULT READ_AHEAD PREFETCH enumDescriptions A regular content read. A read-ahead read (aka cache warming). A prefetching read. location query type string path v1/{+imageProject}/files/{+contentHash} response $ref ReadContentReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write layers methods get description Get the filesystem metadata for an individual layer of an image. flatPath v1/projects/{projectsId}/layers/{layersId} httpMethod GET id containerfilesystem.projects.layers.get parameterOrder imageProject layerId parameters accessToken description Access token used to verify access. Not used in GAE Riptide. location query type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string layerId description The layer ID, e.g. "sha256:abc...def" location path pattern ^[^/]+$ required True type string retryAttempt description Retry attempt number. format int32 location query type integer path v1/{+imageProject}/layers/{+layerId} response $ref LayerReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write prefetch methods get description Get the prefetch list bucket content of a specific image. flatPath v1/projects/{projectsId}/prefetch/{prefetchId} httpMethod GET id containerfilesystem.projects.prefetch.get parameterOrder imageProject filesystemId parameters accessToken description Serialized riptide.PrefetchAccessToken (from AuthImageReply.prefetch_token), encrypted with the server key and base64 encoded. This field is optional and set only if the API authentication is enabled. optional location query type string contextKey description Context key used to distinguish runs of the same image but with different parameters or arguments. location query type string filesystemId description The filesystem identifier, as defined in [MakeFileSystemID](http://google3/apphosting/sandbox/titanium/multi_container.cc?l=425&rcl=327218176). location path pattern ^[^/]+$ required True type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string path v1/{+imageProject}/prefetch/{+filesystemId} response $ref PrefetchImageReportReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write revision 20250125 rootUrl https://containerfilesystem.googleapis.com/ schemas APIBackoffConfig id APIBackoffConfig properties initialInterval description Initial duration for an RPC call retry policy. format google-duration type string maxDuration description Maximum duration for an RPC call retry policy. format google-duration type string maxRetries description Maximum number of retries for an RPC call. format uint64 type string multiplier description Exponential backoff multiplier for an RPC call retry policy. format double type number randomizationFactor description Randomization factor for an RPC call retry policy. format double type number type object AuthImageReply id AuthImageReply properties config $ref Config description The image config (env, port, cmd, ...) retrieved from Riptide Spanner. This will be useful for OnePlatform FUSE to populate the image config blob content as a FUSE file entry, so that `ctr run --rootfs ... --env ...` cmd can be easily executed, without having to perform a GET config blob req. imageId description Riptide image id (digest of the config file for docker schema 2) type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide (Cloud Riptide). Any subsequent RPC calls (GetLayer, ReadContent, GetPrefetchImageReport) should copy this value over to their corresponding request's image_project field. type string layers description A list of layers sorted by position, i.e. the first layer is the top-most layer of the image. The Layer proto also includes the encrypted LayerAccessToken which is required to access the respective layer and files within the layer. items $ref Layer type array prefetchToken description Encrypted and Base64 encoded prefetch token (PrefetchAccessToken protobuf message, serialized and encrypted with the server's key, which is not known to the client) type string serverParameters $ref ServerParameters description These parameters override the default const values or the values provided via command line flags. Parameter's 'scope' defines how it is pushed and how it is applied. The parameter scopes are defined as follows: - 'client' - applies to all features and RPCs of a particular client instance. These parameters are only honored when pushed in the reply of the initial AuthImage probe call. - 'image' - applies to features and RPC issued by particular client instance on the per-image basis.These parameters can be pushed in any AuthImage RPC reply. tokenExpirationTimeMs description Timestamp when the access token expires. format int64 type string type object AuthImageRequest id AuthImageRequest properties clientPlatform $ref ClientPlatform description Architecture and OS AuthImage uses to get the manifest from the manifest list. This is for multiplatform support. imageName description Full image name e.g. gcr.io/my-project/repo/image:tag or gcr.io/my-project/repo/image@digest type string pullSecret description Registry login credential ("(oauth2accesstoken|_json_key(_base64)?):.*") to support GKE imagePullSecrets (http://shortn/_V9ztR0xHVE). Allowed/ supported usernames/passwords are based on http://shortn/_9XF9GH1QIl. Uses RPC EUC if this field is empty. type string retryAttempt description Retry attempt number. format int32 type integer status description Status that indicates the current stage of image caching on GCFSD side. See go/riptide-authimage-heartbeat for more details. enum DEFAULT INITIAL REFRESH CACHED CACHE_DISABLED PROBE enumDescriptions Default value received from old clients that do not distinguish between different AuthImage types. First AuthImageRequest sent for image. Auth refresh heartbeat before image is fully cached. Image has been fully cached by client. The client has cache disabled. Initial server probing. type string type object ClientConfig id ClientConfig properties authImageBackoff $ref APIBackoffConfig description Backoff policy parameters for the AuthImage RPC. The max_duration field is ignored since AuthImage uses a constant backoff policy. policy. enableSingleFlighting description If set, enables/disables the single flighting for an image. type boolean getLayerBackoff $ref APIBackoffConfig description Backoff policy parameters for the GetLayer RPC. readAheadMaxBlocks description If set, enables/disables the read-ahead feature. format int64 type string readContentBackoff $ref APIBackoffConfig description Backoff policy parameters for the ReadContent RPC. type object ClientPlatform id ClientPlatform properties architecture description The architecture used to get the manifest from the manifest list. type string os description The OS used to get the manifest from the manifest list. type string type object Cmd description Defines the command that should be run in the container id Cmd properties args description The arguments to supply the executable items type string type array exec description The executable name (may be resolved with $PATH from Env) required type string type object Config description Configuration for a single container, extracted from the image manifest. This is going to be built with non_prod compatibility, so we should avoid putting any trade secrets in this proto. NEXT TAG: 13 id Config properties architecture description The architecture that the image is built for type string cmd $ref Cmd description The resolved command that should be run command description The CMD of a container. See https://docs.docker.com/engine/reference/builder/#cmd items type string type array dir description The working directory type string entrypoint description The ENTRYPOINT of a container. See https://docs.docker.com/engine/reference/builder/#entrypoint items type string type array env description The environment variables and values to set items $ref Env type array foundVarLog description The image has /var/log directory or not. If yes, the overlay (go/gvisor-overlay) can be configured to /var/log when Logging Fs is mounted at this dir. The overlay will auto-mount any subdirectories recursively under /var/log. type boolean image description The image ID type string labels description A set of labels recorded on the container. This is just raw data coming from the OCI container metadata. items $ref Label type array os description The OS that the image is built for type string port description The network ports to expose items $ref Port type array user description The user[:group] for the command (i.e. the Dockerfile USER, verbatim) type string type object Directory description A (complete) directory in a filesystem layer. id Directory properties entries description Files in this directory. items $ref Entry type array opaque description True if the directory should not be merged with lower layers. type boolean path description The full path to the directory, excluding the leading "/". For example, "/" is the empty string, and "/usr" is represented as "usr". type string type object Entry description A single directory entry in a filesystem layer. id Entry properties name description The name of the directory entry, relative to the directory path. type string stat $ref FileStat description The filesystem metadata for the directory entry. type object Env description Defines an environment variable id Env properties name description Environment variable name, e.g. "PATH" required type string value description Environment variable value, e.g. "/usr/bin:/usr/sbin" type string type object ExtendedAttribute description File extended attributes entry. id ExtendedAttribute properties name type string value format byte type string type object FileBlock description A block of a file in the Riptide filesystem. id FileBlock properties blockData description The block contents. format byte type string blockHash description The SHA256 hexdigest of the block contents. type string lastBlock description Whether the block is the last block in the file. type boolean lowerBound description The lower bound (offset) of the block within the file. Inclusive. format int64 type string upperBound description The upper bound (offset+limit) of the block within the file. Exclusive: the block_data contains the range [lower_bound, upper_bound). format int64 type string type object FileStat description Riptide filesystem metadata for a file. LINT.IfChange id FileStat properties contentHash description SHA256 hexdigest of file contents. type string extendedAttributes description File extended attributes. More info at go/riptide-linux-xattr-support. This may not be populated for the images that do not have xattr support yet. TODO (b/204105260): Change the comment once all the images in Spanner are re-imported with xattr support. items $ref ExtendedAttribute type array gid description GID of file owner. format int32 type integer inlined description Whether the file came from an InlineLayer overlay. type boolean link description Link target (for hard and soft links). type string mode description Linux mode and permission bits. format uint32 type integer mtime description File modification timestamp (microseconds since Unix epoch). format int64 type string size description File size in bytes. format int64 type string uid description UID of file owner. format int32 type integer whiteout description Whether the file is a whiteout. type boolean type object ImageConfig id ImageConfig properties enablePrefetching description If set, enables/disables prefetching for an image. type boolean type object Label description Label is a simple key-value pair. id Label properties key type string value type string type object Layer description Describes a Docker image layer. id Layer properties bytesImported description compared with `layer_info.raw_bytes` to see progress, and can be used in combination with `import_start_time_usec` and the current timestamp to estimate the speed of the layer import. format int64 type string decryptedId description The decrypted layer ID. Populated only if `project_encryption_key_id` is non-empty. type string diffId description The Docker Diff ID (SHA256 digest of the layer tar). V2 schema only. type string digest description The SHA256 digest of the gzip'd layer tar. type string id description The layer ID. If from a v1 schema, this is the digest of the gzip contents. If from a v2 schema, this is the Docker Diff ID. For layers encrypted with a CMEK key, this ID is also encrypted, and `decrypted_id` contains the original layer ID. required type string importFinishTimeUsec description Unix timestamp (in micros) when the layer import completed, or 0 if the import has not completed. format int64 type string importStartTimeUsec description Unix timestamp (in micros) when the layer import started. format int64 type string lastActiveTimeUsec description The last active timestamp of the layer download from Layers.Task if the Layers.Status is not READY, and taken from ProjectLayers.Task otherwise. This determines if we need to restart the download or verification of a layer. format int64 type string layerAccessToken description Encrypted and Base64 encoded Riptide layer access token (LayerAccessToken protobuf message, serialized and encrypted with the server's key, which is not known to the client) type string layerInfo $ref LayerInfo description Various metatadata characterizing the size and contents, and other aspects of the layer. layerStatus description The status taken directly from Layers.Status. This may be READY even if `status` is not. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string mediaType description Layer media type. Empty for image manifest schema 1. type string projectEncryptionKeyId description Project encryption key ID for CMEK. If empty, the layer is not encrypted with a customer managed encryption key. type string projectLayerStatus description The status taken from ProjectLayers.Status. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string provenance description The layer provenance - where this layer came from (if known). enum PROVENANCE_UNKNOWN PROVENANCE_USER PROVENANCE_GOOGLE enumDescriptions Layer provenance is not known. Layer contains user code. Layer was provided by Google, e.g. in a base image. type string status description The status of the layer import (from Layers, or from ProjectLayers if the Layers.Status is READY). If this is READY, the layer is ready for use in the project. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string type object LayerInfo description Various metatadata characterizing the size and contents, and other aspects of a filesystem layer. id LayerInfo properties aiMlMarkers description Markers in the layer that categorize it as an AI/ML layer. items enum UNSPECIFIED CUDA TENSORFLOW enumDescriptions The layer contains CUDA libraries. The layer contains Tensorflow libraries. type string type array directories description The number of directories (both empty and non-empty) in the layer. format uint32 type integer entries description The number of entries in the layer's tar archive. Includes all directories, files, and whiteouts. format uint32 type integer fileBytes description The total number of bytes in all regular files in the layer. format int64 type string filePathSignature description A signature computed by XOR-ing the fingerprint2011 hashes of the file paths of regular files in the layer. format uint64 type string files description The number of regular files (empty and non-empty) in the layer. format uint32 type integer hardLinks description The number of hard links in the layer. format uint32 type integer rawBytes description The number of bytes in the raw (likely gzip compressed) layer blob that was downloaded from the registry at layer import time. format int64 type string softLinks description The number of soft links in the layer. format uint32 type integer tarBytes description The number of bytes in the layer's uncompressed tar archive. format int64 type string whiteouts description The number of whiteouts in the layer. The .wh..wh..opq file (which marks a directory as opaque) is counted as a whiteout (along with any whiteout files with paths like /path/to/.wh.). format uint32 type integer type object LayerReply description RPC response to the request for a Riptide layer. id LayerReply properties directories description The complete list of directories in this layer. items $ref Directory type array projectKeyId description The project key (DEK) identifier, if the layer is encrypted with CMEK. type string type object Port description Defines a TCP or UDP port by protocol and number id Port properties containerPort description The port number within the container's net namespace (0-65535) required format int32 type integer hostPort description The port number outside of the net namespace (if any) (0-65535) format int32 type integer protocol description The protocol (TCP or UDP) required enum PROTO_NONE PROTO_TCP PROTO_UDP enumDescriptions Unknown TCP UDP type string type object PrefetchFileReport description PrefetchFileReport contains one or more reads within the same file. Each read is associated to a file using its file identifier. This allow the server to be able to authorize the client access to the file. id PrefetchFileReport properties fileId description Field used to uniquely identify a file. If the layer_access_token for the layer is set it means that the authentication is enabled; if so the file_id will be the riptide.FileIdentifier encrypted with the layer_encryption key and base64-encoded (more details at go/riptide-auth-design). If the authentication is not enabled this instead will be the file content_hash. type string filePosition description Position within the merged prefetch list of reads executed by the application. format int32 type integer fileSize description File size, as reported by the prefetch recorder based on the SandboxFS. format int64 type string offsets description List of offsets read within the file. Note that reads are aligned at 1MB block sizes. If the list of offsets is empty indicates that the read covers the whole file. items format int64 type string type array type object PrefetchImageReport description LINT.IfChange id PrefetchImageReport properties contextKey description Context key used to distinguish runs of the same image but with different parameters or arguments. type string creationTimestampMicros description Timestamp creation of this report. format int64 type string filesystemId description The filesystem identifier, as defined in [MakeFileSystemID](http://google3/apphosting/sandbox/titanium/multi_container.cc?l=425&rcl=327218176). type string generation description Initially set to 0 indicates that the report is partial. Values greater than 0 indicates a complete report. For more details about how the value changes as a result of a merge process, please refer to the merge logic at http://google3/cloud/containers/riptide/prefetch/prefetch_list_merge.cc. format int64 type string layers description The list of block reads within a layer issued by the container. items $ref PrefetchLayerReport type array version description This field allows to distinguish between different versions of the prefetch list code. This enables the possibility to change the logic and eventually take actions on old reports generated by the previous logic. Set this value to the cl number that changes the logic. The current value is defined in the Recorder library http://google3/cloud/containers/riptide/prefetch/recorder.cc. format int64 type string type object PrefetchImageReportReply description RPC reply for the GetPrefetchImageReport. id PrefetchImageReportReply properties imageReport $ref PrefetchImageReport description The image report requested. type object PrefetchLayerReport id PrefetchLayerReport properties files description List of file reads issued by the client within this layer. items $ref PrefetchFileReport type array layerId description The layer id. type string type object ReadContentReply description RPC response to the request to read from a file in Riptide. id ReadContentReply properties blocks description File blocks that cover the requested offset and length. items $ref FileBlock type array contentHash description The SHA256 hexdigest of the returned file. This can be used to distinguish whether the fileserver was able to return the decrypted version of the requested encrypted content. type string type object ServerParameters id ServerParameters properties clientConfig $ref ClientConfig description ClientConfig is the configuration for all RPCs/features of a particular client instance. It should be set only once and then it stays immutable. imageConfig $ref ImageConfig description ImageConfig is the configuration for customizing features/RPC behavior on per image basis. type object servicePath title Container File System API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/asia-southeast1-containerfilesystem-v1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/cloud-platform.read-only description View your data across Google Cloud services and see the email address of your Google Account https://www.googleapis.com/auth/devstorage.full_control description Manage your data and permissions in Cloud Storage and see the email address for your Google Account https://www.googleapis.com/auth/devstorage.read_only description View your data in Google Cloud Storage https://www.googleapis.com/auth/devstorage.read_write description Manage your data in Cloud Storage and see the email address of your Google Account basePath baseUrl https://containerfilesystem.googleapis.com/ batchPath batch canonicalName Container File System description Stream images stored in Artifact Registry to GKE discoveryVersion v1 documentationLink https://cloud.google.com/kubernetes-engine/docs/how-to/image-streaming fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id containerfilesystem:v1 kind discovery#restDescription mtlsRootUrl https://containerfilesystem.mtls.googleapis.com/ name containerfilesystem ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects methods auth description Authenticate the request for a given image name. Returns image id and access token. flatPath v1/projects/{projectsId}:auth httpMethod POST id containerfilesystem.projects.auth parameterOrder imageProject parameters imageProject description ID of the project hosting the image in the form of 'projects/my-project'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide (Cloud Riptide). location path pattern ^projects/[^/]+$ required True type string path v1/{+imageProject}:auth request $ref AuthImageRequest response $ref AuthImageReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write resources files methods readContent description Get file contents spanning a requested offset and length within a file. flatPath v1/projects/{projectsId}/files/{filesId} httpMethod GET id containerfilesystem.projects.files.readContent parameterOrder imageProject contentHash parameters accessToken description Access token used to verify access. Not used in GAE Riptide. location query type string contentHash description The SHA256 hexdigest of the file contents (uniquely identifies the file). location path pattern ^[^/]+$ required True type string decryptedContentHash description The SHA256 hexdigest of the decrypted file contents. If set, this means the content_hash field is the encrypted content hash. If the decrypted content is in fileserver caches, it will be returned instead of the encrypted content specified by the content_hash field. The client can determine which version was returned by inspecting the content_hash field of the reply. location query type string filePath description File path is optional unless auth is enabled. File path is used to optimize lookups if a given file is in the authorized layer from access token. location query type string fileSize description File size is optional, and is a hint to the file server, which can use the hint to speculate whether the file is a single-block file. format int64 location query type string imageId description Optional image ID where the file resides. Used only for prefetch list recording on fileserver-proxy for OnePlatform (GKE FUSE) clients. location query type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string length description The length to read. format int64 location query type string offset description The offset into the file from which to read. format int64 location query type string readSessionId description The id of the session (read-ahead/prefetch) that the current request belongs to. It takes the following forms: - "original_req_offset:original_req_length:read_ahead_size" for read ahead. location query type string retryAttempt description Retry attempt number. format int32 location query type integer type description Read type. Can be used by the backend for request handling and logging. enum DEFAULT READ_AHEAD PREFETCH enumDescriptions A regular content read. A read-ahead read (aka cache warming). A prefetching read. location query type string path v1/{+imageProject}/files/{+contentHash} response $ref ReadContentReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write layers methods get description Get the filesystem metadata for an individual layer of an image. flatPath v1/projects/{projectsId}/layers/{layersId} httpMethod GET id containerfilesystem.projects.layers.get parameterOrder imageProject layerId parameters accessToken description Access token used to verify access. Not used in GAE Riptide. location query type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string layerId description The layer ID, e.g. "sha256:abc...def" location path pattern ^[^/]+$ required True type string retryAttempt description Retry attempt number. format int32 location query type integer path v1/{+imageProject}/layers/{+layerId} response $ref LayerReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write prefetch methods get description Get the prefetch list bucket content of a specific image. flatPath v1/projects/{projectsId}/prefetch/{prefetchId} httpMethod GET id containerfilesystem.projects.prefetch.get parameterOrder imageProject filesystemId parameters accessToken description Serialized riptide.PrefetchAccessToken (from AuthImageReply.prefetch_token), encrypted with the server key and base64 encoded. This field is optional and set only if the API authentication is enabled. optional location query type string contextKey description Context key used to distinguish runs of the same image but with different parameters or arguments. location query type string filesystemId description The filesystem identifier, as defined in [MakeFileSystemID](http://google3/apphosting/sandbox/titanium/multi_container.cc?l=425&rcl=327218176). location path pattern ^[^/]+$ required True type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string path v1/{+imageProject}/prefetch/{+filesystemId} response $ref PrefetchImageReportReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write revision 20250125 rootUrl https://containerfilesystem.googleapis.com/ schemas APIBackoffConfig id APIBackoffConfig properties initialInterval description Initial duration for an RPC call retry policy. format google-duration type string maxDuration description Maximum duration for an RPC call retry policy. format google-duration type string maxRetries description Maximum number of retries for an RPC call. format uint64 type string multiplier description Exponential backoff multiplier for an RPC call retry policy. format double type number randomizationFactor description Randomization factor for an RPC call retry policy. format double type number type object AuthImageReply id AuthImageReply properties config $ref Config description The image config (env, port, cmd, ...) retrieved from Riptide Spanner. This will be useful for OnePlatform FUSE to populate the image config blob content as a FUSE file entry, so that `ctr run --rootfs ... --env ...` cmd can be easily executed, without having to perform a GET config blob req. imageId description Riptide image id (digest of the config file for docker schema 2) type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide (Cloud Riptide). Any subsequent RPC calls (GetLayer, ReadContent, GetPrefetchImageReport) should copy this value over to their corresponding request's image_project field. type string layers description A list of layers sorted by position, i.e. the first layer is the top-most layer of the image. The Layer proto also includes the encrypted LayerAccessToken which is required to access the respective layer and files within the layer. items $ref Layer type array prefetchToken description Encrypted and Base64 encoded prefetch token (PrefetchAccessToken protobuf message, serialized and encrypted with the server's key, which is not known to the client) type string serverParameters $ref ServerParameters description These parameters override the default const values or the values provided via command line flags. Parameter's 'scope' defines how it is pushed and how it is applied. The parameter scopes are defined as follows: - 'client' - applies to all features and RPCs of a particular client instance. These parameters are only honored when pushed in the reply of the initial AuthImage probe call. - 'image' - applies to features and RPC issued by particular client instance on the per-image basis.These parameters can be pushed in any AuthImage RPC reply. tokenExpirationTimeMs description Timestamp when the access token expires. format int64 type string type object AuthImageRequest id AuthImageRequest properties clientPlatform $ref ClientPlatform description Architecture and OS AuthImage uses to get the manifest from the manifest list. This is for multiplatform support. imageName description Full image name e.g. gcr.io/my-project/repo/image:tag or gcr.io/my-project/repo/image@digest type string pullSecret description Registry login credential ("(oauth2accesstoken|_json_key(_base64)?):.*") to support GKE imagePullSecrets (http://shortn/_V9ztR0xHVE). Allowed/ supported usernames/passwords are based on http://shortn/_9XF9GH1QIl. Uses RPC EUC if this field is empty. type string retryAttempt description Retry attempt number. format int32 type integer status description Status that indicates the current stage of image caching on GCFSD side. See go/riptide-authimage-heartbeat for more details. enum DEFAULT INITIAL REFRESH CACHED CACHE_DISABLED PROBE enumDescriptions Default value received from old clients that do not distinguish between different AuthImage types. First AuthImageRequest sent for image. Auth refresh heartbeat before image is fully cached. Image has been fully cached by client. The client has cache disabled. Initial server probing. type string type object ClientConfig id ClientConfig properties authImageBackoff $ref APIBackoffConfig description Backoff policy parameters for the AuthImage RPC. The max_duration field is ignored since AuthImage uses a constant backoff policy. policy. enableSingleFlighting description If set, enables/disables the single flighting for an image. type boolean getLayerBackoff $ref APIBackoffConfig description Backoff policy parameters for the GetLayer RPC. readAheadMaxBlocks description If set, enables/disables the read-ahead feature. format int64 type string readContentBackoff $ref APIBackoffConfig description Backoff policy parameters for the ReadContent RPC. type object ClientPlatform id ClientPlatform properties architecture description The architecture used to get the manifest from the manifest list. type string os description The OS used to get the manifest from the manifest list. type string type object Cmd description Defines the command that should be run in the container id Cmd properties args description The arguments to supply the executable items type string type array exec description The executable name (may be resolved with $PATH from Env) required type string type object Config description Configuration for a single container, extracted from the image manifest. This is going to be built with non_prod compatibility, so we should avoid putting any trade secrets in this proto. NEXT TAG: 13 id Config properties architecture description The architecture that the image is built for type string cmd $ref Cmd description The resolved command that should be run command description The CMD of a container. See https://docs.docker.com/engine/reference/builder/#cmd items type string type array dir description The working directory type string entrypoint description The ENTRYPOINT of a container. See https://docs.docker.com/engine/reference/builder/#entrypoint items type string type array env description The environment variables and values to set items $ref Env type array foundVarLog description The image has /var/log directory or not. If yes, the overlay (go/gvisor-overlay) can be configured to /var/log when Logging Fs is mounted at this dir. The overlay will auto-mount any subdirectories recursively under /var/log. type boolean image description The image ID type string labels description A set of labels recorded on the container. This is just raw data coming from the OCI container metadata. items $ref Label type array os description The OS that the image is built for type string port description The network ports to expose items $ref Port type array user description The user[:group] for the command (i.e. the Dockerfile USER, verbatim) type string type object Directory description A (complete) directory in a filesystem layer. id Directory properties entries description Files in this directory. items $ref Entry type array opaque description True if the directory should not be merged with lower layers. type boolean path description The full path to the directory, excluding the leading "/". For example, "/" is the empty string, and "/usr" is represented as "usr". type string type object Entry description A single directory entry in a filesystem layer. id Entry properties name description The name of the directory entry, relative to the directory path. type string stat $ref FileStat description The filesystem metadata for the directory entry. type object Env description Defines an environment variable id Env properties name description Environment variable name, e.g. "PATH" required type string value description Environment variable value, e.g. "/usr/bin:/usr/sbin" type string type object ExtendedAttribute description File extended attributes entry. id ExtendedAttribute properties name type string value format byte type string type object FileBlock description A block of a file in the Riptide filesystem. id FileBlock properties blockData description The block contents. format byte type string blockHash description The SHA256 hexdigest of the block contents. type string lastBlock description Whether the block is the last block in the file. type boolean lowerBound description The lower bound (offset) of the block within the file. Inclusive. format int64 type string upperBound description The upper bound (offset+limit) of the block within the file. Exclusive: the block_data contains the range [lower_bound, upper_bound). format int64 type string type object FileStat description Riptide filesystem metadata for a file. LINT.IfChange id FileStat properties contentHash description SHA256 hexdigest of file contents. type string extendedAttributes description File extended attributes. More info at go/riptide-linux-xattr-support. This may not be populated for the images that do not have xattr support yet. TODO (b/204105260): Change the comment once all the images in Spanner are re-imported with xattr support. items $ref ExtendedAttribute type array gid description GID of file owner. format int32 type integer inlined description Whether the file came from an InlineLayer overlay. type boolean link description Link target (for hard and soft links). type string mode description Linux mode and permission bits. format uint32 type integer mtime description File modification timestamp (microseconds since Unix epoch). format int64 type string size description File size in bytes. format int64 type string uid description UID of file owner. format int32 type integer whiteout description Whether the file is a whiteout. type boolean type object ImageConfig id ImageConfig properties enablePrefetching description If set, enables/disables prefetching for an image. type boolean type object Label description Label is a simple key-value pair. id Label properties key type string value type string type object Layer description Describes a Docker image layer. id Layer properties bytesImported description compared with `layer_info.raw_bytes` to see progress, and can be used in combination with `import_start_time_usec` and the current timestamp to estimate the speed of the layer import. format int64 type string decryptedId description The decrypted layer ID. Populated only if `project_encryption_key_id` is non-empty. type string diffId description The Docker Diff ID (SHA256 digest of the layer tar). V2 schema only. type string digest description The SHA256 digest of the gzip'd layer tar. type string id description The layer ID. If from a v1 schema, this is the digest of the gzip contents. If from a v2 schema, this is the Docker Diff ID. For layers encrypted with a CMEK key, this ID is also encrypted, and `decrypted_id` contains the original layer ID. required type string importFinishTimeUsec description Unix timestamp (in micros) when the layer import completed, or 0 if the import has not completed. format int64 type string importStartTimeUsec description Unix timestamp (in micros) when the layer import started. format int64 type string lastActiveTimeUsec description The last active timestamp of the layer download from Layers.Task if the Layers.Status is not READY, and taken from ProjectLayers.Task otherwise. This determines if we need to restart the download or verification of a layer. format int64 type string layerAccessToken description Encrypted and Base64 encoded Riptide layer access token (LayerAccessToken protobuf message, serialized and encrypted with the server's key, which is not known to the client) type string layerInfo $ref LayerInfo description Various metatadata characterizing the size and contents, and other aspects of the layer. layerStatus description The status taken directly from Layers.Status. This may be READY even if `status` is not. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string mediaType description Layer media type. Empty for image manifest schema 1. type string projectEncryptionKeyId description Project encryption key ID for CMEK. If empty, the layer is not encrypted with a customer managed encryption key. type string projectLayerStatus description The status taken from ProjectLayers.Status. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string provenance description The layer provenance - where this layer came from (if known). enum PROVENANCE_UNKNOWN PROVENANCE_USER PROVENANCE_GOOGLE enumDescriptions Layer provenance is not known. Layer contains user code. Layer was provided by Google, e.g. in a base image. type string status description The status of the layer import (from Layers, or from ProjectLayers if the Layers.Status is READY). If this is READY, the layer is ready for use in the project. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string type object LayerInfo description Various metatadata characterizing the size and contents, and other aspects of a filesystem layer. id LayerInfo properties aiMlMarkers description Markers in the layer that categorize it as an AI/ML layer. items enum UNSPECIFIED CUDA TENSORFLOW enumDescriptions The layer contains CUDA libraries. The layer contains Tensorflow libraries. type string type array directories description The number of directories (both empty and non-empty) in the layer. format uint32 type integer entries description The number of entries in the layer's tar archive. Includes all directories, files, and whiteouts. format uint32 type integer fileBytes description The total number of bytes in all regular files in the layer. format int64 type string filePathSignature description A signature computed by XOR-ing the fingerprint2011 hashes of the file paths of regular files in the layer. format uint64 type string files description The number of regular files (empty and non-empty) in the layer. format uint32 type integer hardLinks description The number of hard links in the layer. format uint32 type integer rawBytes description The number of bytes in the raw (likely gzip compressed) layer blob that was downloaded from the registry at layer import time. format int64 type string softLinks description The number of soft links in the layer. format uint32 type integer tarBytes description The number of bytes in the layer's uncompressed tar archive. format int64 type string whiteouts description The number of whiteouts in the layer. The .wh..wh..opq file (which marks a directory as opaque) is counted as a whiteout (along with any whiteout files with paths like /path/to/.wh.). format uint32 type integer type object LayerReply description RPC response to the request for a Riptide layer. id LayerReply properties directories description The complete list of directories in this layer. items $ref Directory type array projectKeyId description The project key (DEK) identifier, if the layer is encrypted with CMEK. type string type object Port description Defines a TCP or UDP port by protocol and number id Port properties containerPort description The port number within the container's net namespace (0-65535) required format int32 type integer hostPort description The port number outside of the net namespace (if any) (0-65535) format int32 type integer protocol description The protocol (TCP or UDP) required enum PROTO_NONE PROTO_TCP PROTO_UDP enumDescriptions Unknown TCP UDP type string type object PrefetchFileReport description PrefetchFileReport contains one or more reads within the same file. Each read is associated to a file using its file identifier. This allow the server to be able to authorize the client access to the file. id PrefetchFileReport properties fileId description Field used to uniquely identify a file. If the layer_access_token for the layer is set it means that the authentication is enabled; if so the file_id will be the riptide.FileIdentifier encrypted with the layer_encryption key and base64-encoded (more details at go/riptide-auth-design). If the authentication is not enabled this instead will be the file content_hash. type string filePosition description Position within the merged prefetch list of reads executed by the application. format int32 type integer fileSize description File size, as reported by the prefetch recorder based on the SandboxFS. format int64 type string offsets description List of offsets read within the file. Note that reads are aligned at 1MB block sizes. If the list of offsets is empty indicates that the read covers the whole file. items format int64 type string type array type object PrefetchImageReport description LINT.IfChange id PrefetchImageReport properties contextKey description Context key used to distinguish runs of the same image but with different parameters or arguments. type string creationTimestampMicros description Timestamp creation of this report. format int64 type string filesystemId description The filesystem identifier, as defined in [MakeFileSystemID](http://google3/apphosting/sandbox/titanium/multi_container.cc?l=425&rcl=327218176). type string generation description Initially set to 0 indicates that the report is partial. Values greater than 0 indicates a complete report. For more details about how the value changes as a result of a merge process, please refer to the merge logic at http://google3/cloud/containers/riptide/prefetch/prefetch_list_merge.cc. format int64 type string layers description The list of block reads within a layer issued by the container. items $ref PrefetchLayerReport type array version description This field allows to distinguish between different versions of the prefetch list code. This enables the possibility to change the logic and eventually take actions on old reports generated by the previous logic. Set this value to the cl number that changes the logic. The current value is defined in the Recorder library http://google3/cloud/containers/riptide/prefetch/recorder.cc. format int64 type string type object PrefetchImageReportReply description RPC reply for the GetPrefetchImageReport. id PrefetchImageReportReply properties imageReport $ref PrefetchImageReport description The image report requested. type object PrefetchLayerReport id PrefetchLayerReport properties files description List of file reads issued by the client within this layer. items $ref PrefetchFileReport type array layerId description The layer id. type string type object ReadContentReply description RPC response to the request to read from a file in Riptide. id ReadContentReply properties blocks description File blocks that cover the requested offset and length. items $ref FileBlock type array contentHash description The SHA256 hexdigest of the returned file. This can be used to distinguish whether the fileserver was able to return the decrypted version of the requested encrypted content. type string type object ServerParameters id ServerParameters properties clientConfig $ref ClientConfig description ClientConfig is the configuration for all RPCs/features of a particular client instance. It should be set only once and then it stays immutable. imageConfig $ref ImageConfig description ImageConfig is the configuration for customizing features/RPC behavior on per image basis. type object servicePath title Container File System API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/asia-southeast1-content-texttospeech-	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/asia-southeast1-content-texttospeech-v1	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/asia-southeast1-content-texttospeech-v1beta1	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/asia-southeast1-datacatalog-	values_changed root['revision'] new_value 20250131 old_value 20250122
prod/asia-southeast1-datacatalog-v1	values_changed root['revision'] new_value 20250131 old_value 20250122
prod/asia-southeast1-datacatalog-v1beta1	values_changed root['revision'] new_value 20250131 old_value 20250122
prod/asia-southeast1-datalineage-	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/asia-southeast1-datalineage-v1	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/asia-southeast1-gkemulticloud-	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/asia-southeast1-gkemulticloud-v1	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/asia-southeast1-healthcare-	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['methods']['retrieveRendered']['parameters']['viewport'] root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['resources']['frames']['methods']['retrieveRendered']['parameters']['viewport'] values_changed root['revision'] new_value 20250129 old_value 20250127
prod/asia-southeast1-healthcare-v1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['methods']['retrieveRendered']['parameters']['viewport'] root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['resources']['frames']['methods']['retrieveRendered']['parameters']['viewport'] values_changed root['revision'] new_value 20250129 old_value 20250127
prod/asia-southeast1-healthcare-v1alpha2	values_changed root['revision'] new_value 20250129 old_value 20250127
prod/asia-southeast1-healthcare-v1beta1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['methods']['retrieveRendered']['parameters']['viewport'] root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['resources']['frames']['methods']['retrieveRendered']['parameters']['viewport'] values_changed root['revision'] new_value 20250129 old_value 20250127
prod/asia-southeast1-iamcredentials-	values_changed root['revision'] new_value 20250130 old_value 20250122
prod/asia-southeast1-iamcredentials-v1	values_changed root['revision'] new_value 20250130 old_value 20250122
prod/asia-southeast1-logging-v1beta3	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/asia-southeast1-monitoring-	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/asia-southeast1-monitoring-v1	dictionary_item_removed root['schemas']['PieChartDataSet']['properties']['breakdowns'] values_changed root['revision'] new_value 20250127 old_value 20250120
prod/asia-southeast1-monitoring-v3	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/asia-southeast1-texttospeech-	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/asia-southeast1-texttospeech-v1	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/asia-southeast1-texttospeech-v1beta1	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/asia-southeast1-workflowexecutions-	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/asia-southeast1-workflowexecutions-v1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/asia-southeast1-workflowexecutions-v1alpha1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/asia-southeast1-workflowexecutions-v1beta	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/asia-southeast2-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/asia-southeast2-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/assuredworkloads-	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/assuredworkloads-v1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/assuredworkloads-v1beta1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/australia-southeast1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast1-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/australia-southeast2-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/authorizedbuyersmarketplace-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/authorizedbuyersmarketplace-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/authorizedbuyersmarketplace-v1alpha	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/automl-	values_changed root['revision'] new_value 20250120 old_value 20250202
prod/automl-v1p1beta	values_changed root['revision'] new_value 20250202 old_value 20250120
prod/batch-v1	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/batch-v1alpha	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/bifrost-hr-c2p-	values_changed root['revision'] new_value 20250128 old_value 20250121
prod/bifrost-hr-c2p-v1	values_changed root['revision'] new_value 20250128 old_value 20250121
prod/bifrost-webconverter-c2p-	values_changed root['revision'] new_value 20250128 old_value 20250121
prod/bifrost-webconverter-c2p-v1	values_changed root['revision'] new_value 20250128 old_value 20250121
prod/blogger-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/blogger-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/blogger-v2	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/blogger-v3	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/bloggermobile-pa-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/bloggermobile-pa-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/bloggermobile-pa-v2	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/bloggermobile-pa-v3	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/books-	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/books-v1	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/books-v1internal	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/businessprofileperformance-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/businessprofileperformance-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/canary-cloudsearch-	values_changed root['revision'] new_value 20250205 old_value 20250129
prod/canary-cloudsearch-v1	values_changed root['revision'] new_value 20250205 old_value 20250129
prod/carddav-	values_changed root['revision'] new_value 20250205 old_value 20250202
prod/carddav-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/checks-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/checks-v1alpha	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/chromedevicetoken-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/chromedevicetoken-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/chromemanagement-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/chromemanagement-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/chromemanagement-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/chromepolicy-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/chromepolicy-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/classroom-	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/classroom-v1	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/cloudaicompanion-	values_changed root['revision'] new_value 20250130 old_value 20250126
prod/cloudaicompanion-v1	values_changed root['revision'] new_value 20250130 old_value 20250126
prod/cloudaicompanion-v1alpha	values_changed root['revision'] new_value 20250130 old_value 20250119
prod/cloudaicompanion-v1beta	values_changed root['revision'] new_value 20250130 old_value 20250126
prod/cloudchannel-	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/cloudchannel-v1	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/cloudchannel-v1alpha1	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/cloudcommerceconsumerprocurement-	values_changed root['revision'] new_value 20250202 old_value 20250129
prod/cloudcommerceconsumerprocurement-v1	values_changed root['revision'] new_value 20250202 old_value 20250129
prod/cloudcommerceconsumerprocurement-v1alpha1	values_changed root['revision'] new_value 20250202 old_value 20250129
prod/cloudcommerceprocurement-	values_changed root['revision'] new_value 20250202 old_value 20250129
prod/cloudcommerceprocurement-v1	values_changed root['revision'] new_value 20250202 old_value 20250129
prod/clouddeploy-	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/clouddeploy-v1	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/cloudoptimization-	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://cloudoptimization.googleapis.com/ batchPath batch canonicalName Cloud Optimization API description Cloud Optimization API provides a portfolio of solvers to address common optimization use cases starting with optimal route planning for vehicle fleets. discoveryVersion v1 documentationLink https://cloud.google.com/optimization/docs/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id cloudoptimization:v1eap kind discovery#restDescription mtlsRootUrl https://cloudoptimization.mtls.googleapis.com/ name cloudoptimization ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations resources operations methods get description Gets 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. flatPath v1eap/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id cloudoptimization.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1eap/{+name} response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform operations methods get description Gets 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. flatPath v1eap/projects/{projectsId}/operations/{operationsId} httpMethod GET id cloudoptimization.projects.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/operations/[^/]+$ required True type string path v1eap/{+name} response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform revision 20250117 rootUrl https://cloudoptimization.googleapis.com/ schemas GoogleCloudOptimizationV1AsyncModelMetadata description The long running operation metadata for async model related methods. id GoogleCloudOptimizationV1AsyncModelMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the current operation. enum STATE_UNSPECIFIED RUNNING SUCCEEDED CANCELLED FAILED enumDescriptions The default value. This value is used if the state is omitted. Request is being processed. The operation completed successfully. The operation was cancelled. The operation has failed. type string stateMessage description A message providing more details about the current state of the operation. For example, the error message if the operation is failed. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudOptimizationV1BatchOptimizeToursResponse description Response to a `BatchOptimizeToursRequest`. This is returned in the LRO Operation after the operation is complete. id GoogleCloudOptimizationV1BatchOptimizeToursResponse properties type object GoogleCloudOptimizationV1RunOptimizerMetadata description The long running operation metadata for `RunOptimizer` method. id GoogleCloudOptimizationV1RunOptimizerMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the current operation. enum STATE_UNSPECIFIED RUNNING SUCCEEDED FAILED enumDescriptions The default value. This value is used if the state is omitted. Request is being processed. The operation succeeded. The operation failed. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudOptimizationV1RunOptimizerResponse description The response message for `RunOptimizer` method. id GoogleCloudOptimizationV1RunOptimizerResponse properties solution description The name of the solution for this optimization. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/solutions/{solution}" type string type object GoogleCloudOptimizationV1betaAsyncModelMetadata description The long running operation metadata for async model related methods. id GoogleCloudOptimizationV1betaAsyncModelMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the current operation. enum STATE_UNSPECIFIED RUNNING SUCCEEDED CANCELLED FAILED enumDescriptions The default value. This value is used if the state is omitted. Request is being processed. The operation completed successfully. The operation was cancelled. The operation has failed. type string stateMessage description A message providing more details about the current state of the operation. For example, the error message if the operation is failed. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudOptimizationV1betaBatchOptimizeToursResponse description Response to a `BatchOptimizeToursRequest`. This is returned in the LRO Operation after the operation is complete. id GoogleCloudOptimizationV1betaBatchOptimizeToursResponse properties type object GoogleLongrunningOperation description This resource represents a long-running operation that is the result of a network API call. id GoogleLongrunningOperation properties done description If 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. type boolean error $ref GoogleRpcStatus description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object GoogleRpcBadRequest description Describes violations in a client request. This error type focuses on the syntactic aspects of the request. id GoogleRpcBadRequest properties fieldViolations description Describes all violations in a client request. items $ref GoogleRpcBadRequestFieldViolation type array type object GoogleRpcBadRequestFieldViolation description A message type used to describe a single bad request field. id GoogleRpcBadRequestFieldViolation properties description description A description of why the request element is bad. type string field description A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. Consider the following: message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; } optional string email = 1; repeated EmailType type = 2; } string full_name = 1; repeated EmailAddress email_addresses = 2; } In this example, in proto `field` could take one of the following values: * `full_name` for a violation in the `full_name` value * `email_addresses[1].email` for a violation in the `email` field of the first `email_addresses` message * `email_addresses[3].type[2]` for a violation in the second `type` value in the third `email_addresses` message. In JSON, the same values are represented as: * `fullName` for a violation in the `fullName` value * `emailAddresses[1].email` for a violation in the `email` field of the first `emailAddresses` message * `emailAddresses[3].type[2]` for a violation in the second `type` value in the third `emailAddresses` message. type string localizedMessage $ref GoogleRpcLocalizedMessage description Provides a localized error message for field-level errors that is safe to return to the API consumer. reason description The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. type string type object GoogleRpcLocalizedMessage description Provides a localized error message that is safe to return to the user which can be attached to an RPC error. id GoogleRpcLocalizedMessage properties locale description The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" type string message description The localized error message in the above locale. type string type object GoogleRpcStatus description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id GoogleRpcStatus properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object Proto2BridgeMessageSet description This is proto2's version of MessageSet. id Proto2BridgeMessageSet properties type object UtilStatusProto description Wire-format for a Status object id UtilStatusProto properties canonicalCode description The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; format int32 type integer code description Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1; format int32 type integer message description Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3; type string messageSet $ref Proto2BridgeMessageSet description message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5; space description The following are usually only present when code != 0 Space to which this status belongs copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string space = 2; type string type object servicePath title Cloud Optimization API version v1eap version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/cloudoptimization-v1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://cloudoptimization.googleapis.com/ batchPath batch canonicalName Cloud Optimization API description Cloud Optimization API provides a portfolio of solvers to address common optimization use cases starting with optimal route planning for vehicle fleets. discoveryVersion v1 documentationLink https://cloud.google.com/optimization/docs/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id cloudoptimization:v1 kind discovery#restDescription mtlsRootUrl https://cloudoptimization.mtls.googleapis.com/ name cloudoptimization ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects methods batchOptimizeTours description Optimizes vehicle tours for one or more `OptimizeToursRequest` messages as a batch. This method is a Long Running Operation (LRO). The inputs for optimization (`OptimizeToursRequest` messages) and outputs (`OptimizeToursResponse` messages) are read/written from/to Cloud Storage in user-specified format. Like the `OptimizeTours` method, each `OptimizeToursRequest` contains a `ShipmentModel` and returns an `OptimizeToursResponse` containing `ShipmentRoute`s, which are a set of routes to be performed by vehicles minimizing the overall cost. flatPath v1/projects/{projectsId}:batchOptimizeTours httpMethod POST id cloudoptimization.projects.batchOptimizeTours parameterOrder parent parameters parent description Required. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. location path pattern ^projects/[^/]+$ required True type string path v1/{+parent}:batchOptimizeTours request $ref GoogleCloudOptimizationV1BatchOptimizeToursRequest response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform optimizeTours description Sends an `OptimizeToursRequest` containing a `ShipmentModel` and returns an `OptimizeToursResponse` containing `ShipmentRoute`s, which are a set of routes to be performed by vehicles minimizing the overall cost. A `ShipmentModel` model consists mainly of `Shipment`s that need to be carried out and `Vehicle`s that can be used to transport the `Shipment`s. The `ShipmentRoute`s assign `Shipment`s to `Vehicle`s. More specifically, they assign a series of `Visit`s to each vehicle, where a `Visit` corresponds to a `VisitRequest`, which is a pickup or delivery for a `Shipment`. The goal is to provide an assignment of `ShipmentRoute`s to `Vehicle`s that minimizes the total cost where cost has many components defined in the `ShipmentModel`. flatPath v1/projects/{projectsId}:optimizeTours httpMethod POST id cloudoptimization.projects.optimizeTours parameterOrder parent parameters parent description Required. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. location path pattern ^projects/[^/]+$ required True type string path v1/{+parent}:optimizeTours request $ref GoogleCloudOptimizationV1OptimizeToursRequest response $ref GoogleCloudOptimizationV1OptimizeToursResponse scopes https://www.googleapis.com/auth/cloud-platform resources locations methods batchOptimizeTours description Optimizes vehicle tours for one or more `OptimizeToursRequest` messages as a batch. This method is a Long Running Operation (LRO). The inputs for optimization (`OptimizeToursRequest` messages) and outputs (`OptimizeToursResponse` messages) are read/written from/to Cloud Storage in user-specified format. Like the `OptimizeTours` method, each `OptimizeToursRequest` contains a `ShipmentModel` and returns an `OptimizeToursResponse` containing `ShipmentRoute`s, which are a set of routes to be performed by vehicles minimizing the overall cost. flatPath v1/projects/{projectsId}/locations/{locationsId}:batchOptimizeTours httpMethod POST id cloudoptimization.projects.locations.batchOptimizeTours parameterOrder parent parameters parent description Required. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+parent}:batchOptimizeTours request $ref GoogleCloudOptimizationV1BatchOptimizeToursRequest response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform optimizeTours description Sends an `OptimizeToursRequest` containing a `ShipmentModel` and returns an `OptimizeToursResponse` containing `ShipmentRoute`s, which are a set of routes to be performed by vehicles minimizing the overall cost. A `ShipmentModel` model consists mainly of `Shipment`s that need to be carried out and `Vehicle`s that can be used to transport the `Shipment`s. The `ShipmentRoute`s assign `Shipment`s to `Vehicle`s. More specifically, they assign a series of `Visit`s to each vehicle, where a `Visit` corresponds to a `VisitRequest`, which is a pickup or delivery for a `Shipment`. The goal is to provide an assignment of `ShipmentRoute`s to `Vehicle`s that minimizes the total cost where cost has many components defined in the `ShipmentModel`. flatPath v1/projects/{projectsId}/locations/{locationsId}:optimizeTours httpMethod POST id cloudoptimization.projects.locations.optimizeTours parameterOrder parent parameters parent description Required. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+parent}:optimizeTours request $ref GoogleCloudOptimizationV1OptimizeToursRequest response $ref GoogleCloudOptimizationV1OptimizeToursResponse scopes https://www.googleapis.com/auth/cloud-platform resources operations methods get description Gets 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. flatPath v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id cloudoptimization.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1/{+name} response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform workspaces methods create description Creates a workspace to manage a group of resources. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces httpMethod POST id cloudoptimization.projects.locations.workspaces.create parameterOrder parent parameters parent description Required. The parent resource where this workspace will be created. Format: "projects/{project}/locations/{location}" location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string workspaceId description The ID to use for the workspace, which will become the final component of the workspace's resource name. If not provided, an auto-generated ID is used. This value should be 4-63 characters, and valid characters are /a-z-/. If this field is empty, a unique ID will be generated by the server. location query type string path v1/{+parent}/workspaces request $ref GoogleCloudOptimizationV1Workspace response $ref GoogleCloudOptimizationV1Workspace scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a workspace. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId} httpMethod DELETE id cloudoptimization.projects.locations.workspaces.delete parameterOrder name parameters name description Required. The name of the workspace to delete. Format: "projects/{project}/locations/{location}/workspaces/{workspace}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+$ required True type string path v1/{+name} response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform list description Lists all the workspaces under the project within a cloud location. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces httpMethod GET id cloudoptimization.projects.locations.workspaces.list parameterOrder parent parameters filter description Filter expression that matches a subset of the Workspaces to show. For more information about filter syntax, see https://google.aip.dev/160. location query type string pageSize description The maximum number of workspaces to return. The service may return fewer than this value. If unspecified, at most 50 workspaces will be returned. The maximum value is 100; values above 100 will be coerced to 100. format int32 location query type integer pageToken description A page token, received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces` must match the call that provided the page token. location query type string parent description Required. The parent, which owns this collection of workspaces. Format: "projects/{project}/locations/{location}" location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+parent}/workspaces response $ref GoogleCloudOptimizationV1ListWorkspacesResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates a workspace. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId} httpMethod PATCH id cloudoptimization.projects.locations.workspaces.patch parameterOrder name parameters name description The resource name of the workspace. This is a unique identifier. Format: `projects/{project}/locations/{location}/workspaces/{workspace}` location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+$ required True type string updateMask description The list of fields to update. format google-fieldmask location query type string path v1/{+name} request $ref GoogleCloudOptimizationV1Workspace response $ref GoogleCloudOptimizationV1Workspace scopes https://www.googleapis.com/auth/cloud-platform resources optimizers methods create description Creates an optimizer . flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/optimizers httpMethod POST id cloudoptimization.projects.locations.workspaces.optimizers.create parameterOrder parent parameters optimizerId description The ID to use for the optimizer, which will become the final component of the optimizer's resource name. If not provided, an auto-generated ID is used. This value should be 4-63 characters, and valid characters are /a-z-/. If this field is empty, a unique ID is generated by the server. location query type string parent description Required. The parent resource where this optimizer will be created. Format: "projects/{project}/locations/{location}/workspaces/{workspace}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+$ required True type string path v1/{+parent}/optimizers request $ref GoogleCloudOptimizationV1Optimizer response $ref GoogleCloudOptimizationV1Optimizer scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes an optimizer. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/optimizers/{optimizersId} httpMethod DELETE id cloudoptimization.projects.locations.workspaces.optimizers.delete parameterOrder name parameters name description Required. The name of the optimizer to delete. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/optimizers/{optimizer}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/optimizers/[^/]+$ required True type string path v1/{+name} response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform get description Gets an optimizer. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/optimizers/{optimizersId} httpMethod GET id cloudoptimization.projects.locations.workspaces.optimizers.get parameterOrder name parameters name description Required. The name of the optimizer to retrieve. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/optimizers/{optimizer}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/optimizers/[^/]+$ required True type string path v1/{+name} response $ref GoogleCloudOptimizationV1Optimizer scopes https://www.googleapis.com/auth/cloud-platform list description Lists the optimizers within a workspace. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/optimizers httpMethod GET id cloudoptimization.projects.locations.workspaces.optimizers.list parameterOrder parent parameters filter description Filter expression that matches a subset of the Optimizers to show. For more information about filter syntax, see https://google.aip.dev/160. location query type string pageSize description The maximum number of optimizers to return. The service may return fewer than this value. If unspecified, at most 50 optimizers will be returned. The maximum value is 100; values above 100 will be coerced to 100. format int32 location query type integer pageToken description A page token, received from a previous `ListOptimizers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOptimizers` must match the call that provided the page token. location query type string parent description Required. The parent, which owns this collection of optimizers. Format: "projects/{project}/locations/{location}/workspaces/{workspace}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+$ required True type string path v1/{+parent}/optimizers response $ref GoogleCloudOptimizationV1ListOptimizersResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates an optimizer. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/optimizers/{optimizersId} httpMethod PATCH id cloudoptimization.projects.locations.workspaces.optimizers.patch parameterOrder name parameters name description The resource name of the optimizer. Format: `projects/{project}/locations/{location}/workspaces/{workspace}/Optimizers/{optimizer}` location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/optimizers/[^/]+$ required True type string updateMask description The list of fields to update. format google-fieldmask location query type string path v1/{+name} request $ref GoogleCloudOptimizationV1Optimizer response $ref GoogleCloudOptimizationV1Optimizer scopes https://www.googleapis.com/auth/cloud-platform run description Run the optimizer to generate a solution based on updated entities (e.g. shipments and vehicles), the solution under execution, and other related constraints. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/optimizers/{optimizersId}:run httpMethod POST id cloudoptimization.projects.locations.workspaces.optimizers.run parameterOrder name parameters name description Required. The name of the optimizer to run an optimization. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/optimizers/{optimizer}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/optimizers/[^/]+$ required True type string path v1/{+name}:run request $ref GoogleCloudOptimizationV1RunOptimizerRequest response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform shipments methods create description Creates a shipment. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/shipments httpMethod POST id cloudoptimization.projects.locations.workspaces.shipments.create parameterOrder parent parameters parent description Required. The parent resource where this shipment will be created. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/shipments/{shipment}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+$ required True type string shipmentId description The ID to use for the shipment, which will become the final component of the shipment's resource name. If not provided, an auto-generated ID is used. This value should be 4-63 characters, and valid characters are /a-z-/. If this field is empty, a unique ID is generated by the server. location query type string path v1/{+parent}/shipments request $ref GoogleCloudOptimizationV1Shipment response $ref GoogleCloudOptimizationV1Shipment scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a shipment. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/shipments/{shipmentsId} httpMethod DELETE id cloudoptimization.projects.locations.workspaces.shipments.delete parameterOrder name parameters name description Required. The name of the shipment to delete. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/shipments/{shipment}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/shipments/[^/]+$ required True type string path v1/{+name} response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform get description Gets a shipment. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/shipments/{shipmentsId} httpMethod GET id cloudoptimization.projects.locations.workspaces.shipments.get parameterOrder name parameters name description Required. The name of the shipment to retrieve. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/shipments/{shipment}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/shipments/[^/]+$ required True type string path v1/{+name} response $ref GoogleCloudOptimizationV1Shipment scopes https://www.googleapis.com/auth/cloud-platform list description Lists the shipments within a workspace. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/shipments httpMethod GET id cloudoptimization.projects.locations.workspaces.shipments.list parameterOrder parent parameters filter description Filter expression that matches a subset of the Shipments to show. For more information about filter syntax, see https://google.aip.dev/160. location query type string pageSize description The maximum number of shipments to return. The service may return fewer than this value. If unspecified, at most 50 vehicles will be returned. The maximum value is 100; values above 100 will be coerced to 100. format int32 location query type integer pageToken description A page token, received from a previous `ListShipments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListShipments` must match the call that provided the page token. location query type string parent description Required. The parent, which owns this collection of shipments. Format: "projects/{project}/locations/{location}/workspaces/{workspace}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+$ required True type string path v1/{+parent}/shipments response $ref GoogleCloudOptimizationV1ListShipmentsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates a shipment. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/shipments/{shipmentsId} httpMethod PATCH id cloudoptimization.projects.locations.workspaces.shipments.patch parameterOrder name parameters name description The resource name of the shipment. This is a unique identifier. Format: `projects/{project}/locations/{location}/workspaces/{workspace}/shipments/{shipment}` This field would be ignored while calling `OptimizeTours` and `BatchOptimizeTours` methods. location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/shipments/[^/]+$ required True type string updateMask description The list of fields to update. format google-fieldmask location query type string path v1/{+name} request $ref GoogleCloudOptimizationV1Shipment response $ref GoogleCloudOptimizationV1Shipment scopes https://www.googleapis.com/auth/cloud-platform solutions methods delete description Deletes a solution. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/solutions/{solutionsId} httpMethod DELETE id cloudoptimization.projects.locations.workspaces.solutions.delete parameterOrder name parameters name description Required. The name of the solution to delete. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/solutions/{solution}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/solutions/[^/]+$ required True type string path v1/{+name} response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform get description Gets a solution. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/solutions/{solutionsId} httpMethod GET id cloudoptimization.projects.locations.workspaces.solutions.get parameterOrder name parameters name description Required. The name of the solution to retrieve. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/solutions/{solution}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/solutions/[^/]+$ required True type string path v1/{+name} response $ref GoogleCloudOptimizationV1Solution scopes https://www.googleapis.com/auth/cloud-platform list description List the solutions based on certain conditions. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/solutions httpMethod GET id cloudoptimization.projects.locations.workspaces.solutions.list parameterOrder parent parameters filter description Filter expression that matches a subset of the Solutions to show. For more information about filter syntax, see https://google.aip.dev/160. location query type string pageSize description The maximum number of solutions to return. The service may return fewer than this value. If unspecified, at most 50 solutions will be returned. The maximum value is 100; values above 100 will be coerced to 100. format int32 location query type integer pageToken description A page token, received from a previous `ListSolutions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSolutions` must match the call that provided the page token. location query type string parent description Required. The parent, which owns this collection of solutions. Format: "projects/{project}/locations/{location}/workspaces/{workspace}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+$ required True type string path v1/{+parent}/solutions response $ref GoogleCloudOptimizationV1ListSolutionsResponse scopes https://www.googleapis.com/auth/cloud-platform retrieveInput description Retrieves the `OptimizeToursRequest` that corresponds to the solution. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/solutions/{solutionsId}:retrieveInput httpMethod GET id cloudoptimization.projects.locations.workspaces.solutions.retrieveInput parameterOrder name parameters name description Required. The name of the solution to retrieve the corresponding `OptimizeToursRequest`. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/solutions/{solution}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/solutions/[^/]+$ required True type string path v1/{+name}:retrieveInput response $ref GoogleCloudOptimizationV1RetrieveInputResponse scopes https://www.googleapis.com/auth/cloud-platform vehicles methods create description Creates a vehicle. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/vehicles httpMethod POST id cloudoptimization.projects.locations.workspaces.vehicles.create parameterOrder parent parameters parent description Required. The parent resource where this vehicle will be created. Format: "projects/{project}/locations/{location}/workspaces/{workspace}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+$ required True type string vehicleId description The ID to use for the vehicle, which will become the final component of the vehicle's resource name. If not provided, an auto generated ID is used. This value should be 4-63 characters, and valid characters are /a-z-/. If this field is empty, a unique ID is generated by the server. location query type string path v1/{+parent}/vehicles request $ref GoogleCloudOptimizationV1Vehicle response $ref GoogleCloudOptimizationV1Vehicle scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a vehicle. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/vehicles/{vehiclesId} httpMethod DELETE id cloudoptimization.projects.locations.workspaces.vehicles.delete parameterOrder name parameters name description Required. The name of the vehicle to delete. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/vehicles/{vehicle}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/vehicles/[^/]+$ required True type string path v1/{+name} response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform get description Gets a vehicle. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/vehicles/{vehiclesId} httpMethod GET id cloudoptimization.projects.locations.workspaces.vehicles.get parameterOrder name parameters name description Required. The name of the vehicle to retrieve. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/vehicles/{vehicle}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/vehicles/[^/]+$ required True type string path v1/{+name} response $ref GoogleCloudOptimizationV1Vehicle scopes https://www.googleapis.com/auth/cloud-platform list description Lists the vehicles within a workspace. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/vehicles httpMethod GET id cloudoptimization.projects.locations.workspaces.vehicles.list parameterOrder parent parameters filter description Filter expression that matches a subset of the Vehicles to show. For more information about filter syntax, see https://google.aip.dev/160. location query type string pageSize description The maximum number of vehicles to return. The service may return fewer than this value. If unspecified, at most 50 vehicles will be returned. The maximum value is 100; values above 100 will be coerced to 100. format int32 location query type integer pageToken description A page token, received from a previous `ListVehicles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListVehicles` must match the call that provided the page token. location query type string parent description Required. The parent, which owns this collection of vehicles. Format: "projects/{project}/locations/{location}/workspaces/{workspace}" location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+$ required True type string path v1/{+parent}/vehicles response $ref GoogleCloudOptimizationV1ListVehiclesResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates a vehicle. flatPath v1/projects/{projectsId}/locations/{locationsId}/workspaces/{workspacesId}/vehicles/{vehiclesId} httpMethod PATCH id cloudoptimization.projects.locations.workspaces.vehicles.patch parameterOrder name parameters name description The resource name of the vehicle. This is a unique identifier. Format: `projects/{project}/locations/{location}/workspaces/{workspace}/vehicles/{vehicle}` This field would be ignored while calling `OptimizeTours` and `BatchOptimizeTours` methods. location path pattern ^projects/[^/]+/locations/[^/]+/workspaces/[^/]+/vehicles/[^/]+$ required True type string updateMask description The list of fields to update. format google-fieldmask location query type string path v1/{+name} request $ref GoogleCloudOptimizationV1Vehicle response $ref GoogleCloudOptimizationV1Vehicle scopes https://www.googleapis.com/auth/cloud-platform operations methods get description Gets 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. flatPath v1/projects/{projectsId}/operations/{operationsId} httpMethod GET id cloudoptimization.projects.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/operations/[^/]+$ required True type string path v1/{+name} response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform revision 20250117 rootUrl https://cloudoptimization.googleapis.com/ schemas GoogleCloudOptimizationV1AggregatedMetrics description Aggregated metrics for ShipmentRoute (resp. for OptimizeToursResponse over all Transition and/or Visit (resp. over all ShipmentRoute) elements. id GoogleCloudOptimizationV1AggregatedMetrics properties breakDuration description Total break duration for a route or a solution. format google-duration type string costs additionalProperties format double type number deprecated True description Deprecated: Use ShipmentRoute.route_costs and OptimizeToursResponse.Metrics.costs instead. type object delayDuration description Total delay duration for a route or a solution. format google-duration type string maxLoads additionalProperties $ref GoogleCloudOptimizationV1ShipmentRouteVehicleLoad description Maximum load achieved over the entire route (resp. solution), for each of the quantities on this route (resp. solution), computed as the maximum over all Transition.vehicle_loads (resp. ShipmentRoute.metrics.max_loads. type object performedShipmentCount description Number of shipments performed. Note that a pickup and delivery pair only counts once. format int32 type integer totalCost deprecated True description Deprecated: Use ShipmentRoute.route_total_cost and OptimizeToursResponse.Metrics.total_cost instead. format double type number totalDuration description The total duration should be equal to the sum of all durations above. For routes, it also corresponds to: ShipmentRoute.vehicle_end_time `-` ShipmentRoute.vehicle_start_time format google-duration type string travelDistanceMeters description Total travel distance for a route or a solution. format double type number travelDuration description Total travel duration for a route or a solution. format google-duration type string visitDuration description Total visit duration for a route or a solution. format google-duration type string waitDuration description Total wait duration for a route or a solution. format google-duration type string type object GoogleCloudOptimizationV1AsyncModelMetadata description The long running operation metadata for async model related methods. id GoogleCloudOptimizationV1AsyncModelMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the current operation. enum STATE_UNSPECIFIED RUNNING SUCCEEDED CANCELLED FAILED enumDescriptions The default value. This value is used if the state is omitted. Request is being processed. The operation completed successfully. The operation was cancelled. The operation has failed. type string stateMessage description A message providing more details about the current state of the operation. For example, the error message if the operation is failed. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudOptimizationV1BatchOptimizeToursRequest description Request to batch optimize tours as an asynchronous operation. Each input file should contain one `OptimizeToursRequest`, and each output file will contain one `OptimizeToursResponse`. The request contains information to read/write and parse the files. All the input and output files should be under the same project. id GoogleCloudOptimizationV1BatchOptimizeToursRequest properties modelConfigs description Required. Input/Output information each purchase model, such as file paths and data formats. items $ref GoogleCloudOptimizationV1BatchOptimizeToursRequestAsyncModelConfig type array type object GoogleCloudOptimizationV1BatchOptimizeToursRequestAsyncModelConfig description Information for solving one optimization model asynchronously. id GoogleCloudOptimizationV1BatchOptimizeToursRequestAsyncModelConfig properties displayName description User defined model name, can be used as alias by users to keep track of models. type string enableCheckpoints description If this is set, the model will be solved in the checkpoint mode. In this mode, the input model can have a deadline longer than 30 mins without the risk of interruption. The model will be solved in multiple short-running stages. Each stage generates an intermediate checkpoint and stores it in the user's Cloud Storage buckets. The checkpoint mode should be preferred over allow_large_deadline_despite_interruption_risk since it prevents the risk of interruption. type boolean inputConfig $ref GoogleCloudOptimizationV1InputConfig description Required. Information about the input model. outputConfig $ref GoogleCloudOptimizationV1OutputConfig description Required. The desired output location information. type object GoogleCloudOptimizationV1BatchOptimizeToursResponse description Response to a `BatchOptimizeToursRequest`. This is returned in the LRO Operation after the operation is complete. id GoogleCloudOptimizationV1BatchOptimizeToursResponse properties type object GoogleCloudOptimizationV1BreakRule description Rules to generate time breaks for a vehicle (e.g. lunch breaks). A break is a contiguous period of time during which the vehicle remains idle at its current position and cannot perform any visit. A break may occur: * during the travel between two visits (which includes the time right before or right after a visit, but not in the middle of a visit), in which case it extends the corresponding transit time between the visits, * or before the vehicle start (the vehicle may not start in the middle of a break), in which case it does not affect the vehicle start time. * or after the vehicle end (ditto, with the vehicle end time). id GoogleCloudOptimizationV1BreakRule properties breakRequests description Sequence of breaks. See the `BreakRequest` message. items $ref GoogleCloudOptimizationV1BreakRuleBreakRequest type array frequencyConstraints description Several `FrequencyConstraint` may apply. They must all be satisfied by the `BreakRequest`s of this `BreakRule`. See `FrequencyConstraint`. items $ref GoogleCloudOptimizationV1BreakRuleFrequencyConstraint type array type object GoogleCloudOptimizationV1BreakRuleBreakRequest description The sequence of breaks (i.e. their number and order) that apply to each vehicle must be known beforehand. The repeated `BreakRequest`s define that sequence, in the order in which they must occur. Their time windows (`earliest_start_time` / `latest_start_time`) may overlap, but they must be compatible with the order (this is checked). id GoogleCloudOptimizationV1BreakRuleBreakRequest properties earliestStartTime description Required. Lower bound (inclusive) on the start of the break. format google-datetime type string latestStartTime description Required. Upper bound (inclusive) on the start of the break. format google-datetime type string minDuration description Required. Minimum duration of the break. Must be positive. format google-duration type string type object GoogleCloudOptimizationV1BreakRuleFrequencyConstraint description One may further constrain the frequency and duration of the breaks specified above, by enforcing a minimum break frequency, such as "There must be a break of at least 1 hour every 12 hours". Assuming that this can be interpreted as "Within any sliding time window of 12h, there must be at least one break of at least one hour", that example would translate to the following `FrequencyConstraint`: ``` { min_break_duration { seconds: 3600 } # 1 hour. max_inter_break_duration { seconds: 39600 } # 11 hours (12 - 1 = 11). } ``` The timing and duration of the breaks in the solution will respect all such constraints, in addition to the time windows and minimum durations already specified in the `BreakRequest`. A `FrequencyConstraint` may in practice apply to non-consecutive breaks. For example, the following schedule honors the "1h every 12h" example: ``` 04:00 vehicle start .. performing travel and visits .. 09:00 1 hour break 10:00 end of the break .. performing travel and visits .. 12:00 20-min lunch break 12:20 end of the break .. performing travel and visits .. 21:00 1 hour break 22:00 end of the break .. performing travel and visits .. 23:59 vehicle end ``` id GoogleCloudOptimizationV1BreakRuleFrequencyConstraint properties maxInterBreakDuration description Required. Maximum allowed span of any interval of time in the route that does not include at least partially a break of `duration >= min_break_duration`. Must be positive. format google-duration type string minBreakDuration description Required. Minimum break duration for this constraint. Nonnegative. See description of `FrequencyConstraint`. format google-duration type string type object GoogleCloudOptimizationV1CapacityQuantity deprecated True description Deprecated: Use Vehicle.LoadLimit.Interval instead. id GoogleCloudOptimizationV1CapacityQuantity properties type type string value format int64 type string type object GoogleCloudOptimizationV1CapacityQuantityInterval deprecated True description Deprecated: Use Vehicle.LoadLimit.Interval instead. id GoogleCloudOptimizationV1CapacityQuantityInterval properties maxValue format int64 type string minValue format int64 type string type type string type object GoogleCloudOptimizationV1DistanceLimit description A limit defining a maximum distance which can be traveled. It can be either hard or soft. If a soft limit is defined, both `soft_max_meters` and `cost_per_kilometer_above_soft_max` must be defined and be nonnegative. id GoogleCloudOptimizationV1DistanceLimit properties costPerKilometerAboveSoftMax description Cost per kilometer incurred if distance is above `soft_max_meters` limit. The additional cost is 0 if the distance is under the limit, otherwise the formula used to compute the cost is the following: ``` (distance_meters - soft_max_meters) / 1000.0 * cost_per_kilometer_above_soft_max. ``` The cost must be nonnegative. format double type number costPerKilometerBelowSoftMax description Cost per kilometer incurred, increasing up to `soft_max_meters`, with formula: ``` min(distance_meters, soft_max_meters) / 1000.0 * cost_per_kilometer_below_soft_max. ``` This cost is not supported in `route_distance_limit`. format double type number maxMeters description A hard limit constraining the distance to be at most max_meters. The limit must be nonnegative. format int64 type string softMaxMeters description A soft limit not enforcing a maximum distance limit, but when violated results in a cost which adds up to other costs defined in the model, with the same unit. If defined soft_max_meters must be less than max_meters and must be nonnegative. format int64 type string type object GoogleCloudOptimizationV1GcsDestination description The Google Cloud Storage location where the output file will be written to. id GoogleCloudOptimizationV1GcsDestination properties uri description Required. URI of the Google Cloud Storage location. type string type object GoogleCloudOptimizationV1GcsSource description The Google Cloud Storage location where the input file will be read from. id GoogleCloudOptimizationV1GcsSource properties uri description Required. URI of the Google Cloud Storage location. type string type object GoogleCloudOptimizationV1InjectedSolutionConstraint description Solution injected in the request including information about which visits must be constrained and how they must be constrained. id GoogleCloudOptimizationV1InjectedSolutionConstraint properties constraintRelaxations description For zero or more groups of vehicles, specifies when and how much to relax constraints. If this field is empty, all non-empty vehicle routes are fully constrained. items $ref GoogleCloudOptimizationV1InjectedSolutionConstraintConstraintRelaxation type array routes description Routes of the solution to inject. Some routes may be omitted from the original solution. The routes and skipped shipments must satisfy the basic validity assumptions listed for `injected_first_solution_routes`. items $ref GoogleCloudOptimizationV1ShipmentRoute type array skippedShipments description Skipped shipments of the solution to inject. Some may be omitted from the original solution. See the `routes` field. items $ref GoogleCloudOptimizationV1SkippedShipment type array type object GoogleCloudOptimizationV1InjectedSolutionConstraintConstraintRelaxation description For a group of vehicles, specifies at what threshold(s) constraints on visits will be relaxed and to which level. Shipments listed in the `skipped_shipment` field are constrained to be skipped; i.e., they cannot be performed. id GoogleCloudOptimizationV1InjectedSolutionConstraintConstraintRelaxation properties relaxations description All the visit constraint relaxations that will apply to visits on routes with vehicles in `vehicle_indices`. items $ref GoogleCloudOptimizationV1InjectedSolutionConstraintConstraintRelaxationRelaxation type array vehicleIndices description Specifies the vehicle indices to which the visit constraint `relaxations` apply. If empty, this is considered the default and the `relaxations` apply to all vehicles that are not specified in other `constraint_relaxations`. There can be at most one default, i.e., at most one constraint relaxation field is allowed empty `vehicle_indices`. A vehicle index can only be listed once, even within several `constraint_relaxations`. A vehicle index is mapped the same as ShipmentRoute.vehicle_index, if `interpret_injected_solutions_using_labels` is true (see `fields` comment). items format int32 type integer type array type object GoogleCloudOptimizationV1InjectedSolutionConstraintConstraintRelaxationRelaxation description If `relaxations` is empty, the start time and sequence of all visits on `routes` are fully constrained and no new visits may be inserted or added to those routes. Also, a vehicle's start and end time in `routes` is fully constrained, unless the vehicle is empty (i.e., has no visits and has `used_if_route_is_empty` set to false in the model). `relaxations(i).level` specifies the constraint relaxation level applied to a visit #j that satisfies: * `route.visits(j).start_time >= relaxations(i).threshold_time` AND * `j + 1 >= relaxations(i).threshold_visit_count` Similarly, the vehicle start is relaxed to `relaxations(i).level` if it satisfies: * `vehicle_start_time >= relaxations(i).threshold_time` AND * `relaxations(i).threshold_visit_count == 0` and the vehicle end is relaxed to `relaxations(i).level` if it satisfies: * `vehicle_end_time >= relaxations(i).threshold_time` AND * `route.visits_size() + 1 >= relaxations(i).threshold_visit_count` To apply a relaxation level if a visit meets the `threshold_visit_count` OR the `threshold_time` add two `relaxations` with the same `level`: one with only `threshold_visit_count` set and the other with only `threshold_time` set. If a visit satisfies the conditions of multiple `relaxations`, the most relaxed level applies. As a result, from the vehicle start through the route visits in order to the vehicle end, the relaxation level becomes more relaxed: i.e., the relaxation level is non-decreasing as the route progresses. The timing and sequence of route visits that do not satisfy the threshold conditions of any `relaxations` are fully constrained and no visits may be inserted into these sequences. Also, if a vehicle start or end does not satisfy the conditions of any relaxation the time is fixed, unless the vehicle is empty. id GoogleCloudOptimizationV1InjectedSolutionConstraintConstraintRelaxationRelaxation properties level description The constraint relaxation level that applies when the conditions at or after `threshold_time` AND at least `threshold_visit_count` are satisfied. enum LEVEL_UNSPECIFIED RELAX_VISIT_TIMES_AFTER_THRESHOLD RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD RELAX_ALL_AFTER_THRESHOLD enumDescriptions Implicit default relaxation level: no constraints are relaxed, i.e., all visits are fully constrained. This value must not be explicitly used in `level`. Visit start times and vehicle start/end times will be relaxed, but each visit remains bound to the same vehicle and the visit sequence must be observed: no visit can be inserted between them or before them. Same as `RELAX_VISIT_TIMES_AFTER_THRESHOLD`, but the visit sequence is also relaxed: visits can only be performed by this vehicle, but can potentially become unperformed. Same as `RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD`, but the vehicle is also relaxed: visits are completely free at or after the threshold time and can potentially become unperformed. type string thresholdTime description The time at or after which the relaxation `level` may be applied. format google-datetime type string thresholdVisitCount description The number of visits at or after which the relaxation `level` may be applied. If `threshold_visit_count` is 0 (or unset), the `level` may be applied directly at the vehicle start. If it is `route.visits_size() + 1`, the `level` may only be applied to the vehicle end. If it is more than `route.visits_size() + 1`, `level` is not applied at all for that route. format int32 type integer type object GoogleCloudOptimizationV1InputConfig description The desired input location information. id GoogleCloudOptimizationV1InputConfig properties dataFormat description The input data format that used to store the model in Cloud Storage. enum DATA_FORMAT_UNSPECIFIED JSON STRING enumDescriptions Default value. Input data in json format. Input data in string format. type string gcsSource $ref GoogleCloudOptimizationV1GcsSource description The Google Cloud Storage location to read the input from. This must be a single file. type object GoogleCloudOptimizationV1ListOptimizersResponse description The response message for `ListOptimizers` method. id GoogleCloudOptimizationV1ListOptimizersResponse properties nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string optimizers description The optimizers from the specified workspace. items $ref GoogleCloudOptimizationV1Optimizer type array type object GoogleCloudOptimizationV1ListShipmentsResponse description The response message for `ListShipments` method. id GoogleCloudOptimizationV1ListShipmentsResponse properties nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string shipments description The shipments from the specified workspace. items $ref GoogleCloudOptimizationV1Shipment type array type object GoogleCloudOptimizationV1ListSolutionsResponse description The response message for `ListSolutions` method. id GoogleCloudOptimizationV1ListSolutionsResponse properties nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string solutions description The optimizers from the specified workspace. items $ref GoogleCloudOptimizationV1Solution type array type object GoogleCloudOptimizationV1ListVehiclesResponse description The response message for `ListVehicles` method. id GoogleCloudOptimizationV1ListVehiclesResponse properties nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string vehicles description The vehicles from the specified workspace. items $ref GoogleCloudOptimizationV1Vehicle type array type object GoogleCloudOptimizationV1ListWorkspacesResponse description The response message for `ListWorkspaces` method. id GoogleCloudOptimizationV1ListWorkspacesResponse properties nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string workspaces description The workspaces from the specified project and location. items $ref GoogleCloudOptimizationV1Workspace type array type object GoogleCloudOptimizationV1Location description Encapsulates a location (a geographic point, and an optional heading). id GoogleCloudOptimizationV1Location properties heading description The compass heading associated with the direction of the flow of traffic. This value is used to specify the side of the road to use for pickup and drop-off. Heading values can be from 0 to 360, where 0 specifies a heading of due North, 90 specifies a heading of due East, etc. format int32 type integer latLng $ref GoogleTypeLatLng description The waypoint's geographic coordinates. type object GoogleCloudOptimizationV1ModelSpec description Spec that is used for providing global and relational costs and constraints for all optimizations conducted by this optimizer. The fields match their corresponding fields in `ShipmentModel`. id GoogleCloudOptimizationV1ModelSpec properties globalDurationCostPerHour description The "global duration" of the overall plan is the difference between the earliest effective start time and the latest effective end time of all vehicles. Users can assign a cost per hour to be used during the global duration period to try and optimize for earliest job completion, for example. This cost must be in the same unit as Shipment.penalty_cost. format double type number globalEndTime description If unset, 00:00:00 UTC, January 1, 1971 (i.e. seconds: 31536000, nanos: 0) is used as default. format google-datetime type string globalStartTime description Global start and end time of the model: no times outside of this range can be considered valid. The model's time span must be less than a year, i.e. the `global_end_time` and the `global_start_time` must be within 31536000 seconds of each other. When using `cost_per_*hour` fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (i.e. seconds: 0, nanos: 0) is used as default. format google-datetime type string maxActiveVehicles description Constrains the maximum number of active vehicles. A vehicle is active if its route performs at least one shipment. This can be used to limit the number of routes in the case where there are fewer drivers than vehicles and that the fleet of vehicles is heterogeneous. The optimization will then select the best subset of vehicles to use. Must be strictly positive. format int32 type integer precedenceRules description Set of precedence rules which must be enforced in the model. items $ref GoogleCloudOptimizationV1ShipmentModelPrecedenceRule type array shipmentTypeIncompatibilities description Sets of incompatible shipment_types (see `ShipmentTypeIncompatibility`). items $ref GoogleCloudOptimizationV1ShipmentTypeIncompatibility type array shipmentTypeRequirements description Sets of `shipment_type` requirements (see `ShipmentTypeRequirement`). items $ref GoogleCloudOptimizationV1ShipmentTypeRequirement type array transitionAttributes description Transition attributes added to the model. items $ref GoogleCloudOptimizationV1TransitionAttributes type array type object GoogleCloudOptimizationV1OptimizeToursRequest description Request to be given to a tour optimization solver which defines the shipment model to solve as well as optimization parameters. id GoogleCloudOptimizationV1OptimizeToursRequest properties allowLargeDeadlineDespiteInterruptionRisk description If this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines) of up to 60 minutes. Otherwise, the maximum deadline is only 30 minutes. Note that long-lived requests have a significantly larger (but still small) risk of interruption. type boolean considerRoadTraffic description Consider traffic estimation in calculating `ShipmentRoute` fields Transition.travel_duration, Visit.start_time, and `vehicle_end_time`; in setting the ShipmentRoute.has_traffic_infeasibilities field, and in calculating the OptimizeToursResponse.total_cost field. type boolean geodesicMetersPerSecond description When `use_geodesic_distances` is true, this field must be set and defines the speed applied to compute travel times. Its value must be at least 1.0 meters/seconds. format double type number injectedFirstSolutionRoutes description Guide the optimization algorithm in finding a first solution that is similar to a previous solution. The model is constrained when the first solution is built. Any shipments not performed on a route are implicitly skipped in the first solution, but they may be performed in successive solutions. The solution must satisfy some basic validity assumptions: * for all routes, `vehicle_index` must be in range and not be duplicated. * for all visits, `shipment_index` and `visit_request_index` must be in range. * a shipment may only be referenced on one route. * the pickup of a pickup-delivery shipment must be performed before the delivery. * no more than one pickup alternative or delivery alternative of a shipment may be performed. * for all routes, times are increasing (i.e., `vehicle_start_time <= visits[0].start_time <= visits[1].start_time ... <= vehicle_end_time`). * a shipment may only be performed on a vehicle that is allowed. A vehicle is allowed if Shipment.allowed_vehicle_indices is empty or its `vehicle_index` is included in Shipment.allowed_vehicle_indices. If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead. items $ref GoogleCloudOptimizationV1ShipmentRoute type array injectedSolutionConstraint $ref GoogleCloudOptimizationV1InjectedSolutionConstraint description Constrain the optimization algorithm to find a final solution that is similar to a previous solution. For example, this may be used to freeze portions of routes which have already been completed or which are to be completed but must not be modified. If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead. interpretInjectedSolutionsUsingLabels description If true: * uses ShipmentRoute.vehicle_label instead of `vehicle_index` to match routes in an injected solution with vehicles in the request; reuses the mapping of original ShipmentRoute.vehicle_index to new ShipmentRoute.vehicle_index to update ConstraintRelaxation.vehicle_indices if non-empty, but the mapping must be unambiguous (i.e., multiple `ShipmentRoute`s must not share the same original `vehicle_index`). * uses ShipmentRoute.Visit.shipment_label instead of `shipment_index` to match visits in an injected solution with shipments in the request; * uses SkippedShipment.label instead of SkippedShipment.index to match skipped shipments in the injected solution with request shipments. This interpretation applies to the `injected_first_solution_routes`, `injected_solution_constraint`, and `refresh_details_routes` fields. It can be used when shipment or vehicle indices in the request have changed since the solution was created, perhaps because shipments or vehicles have been removed from or added to the request. If true, labels in the following categories must appear at most once in their category: * Vehicle.label in the request; * Shipment.label in the request; * ShipmentRoute.vehicle_label in the injected solution; * SkippedShipment.label and ShipmentRoute.Visit.shipment_label in the injected solution (except pickup/delivery visit pairs, whose `shipment_label` must appear twice). If a `vehicle_label` in the injected solution does not correspond to a request vehicle, the corresponding route is removed from the solution along with its visits. If a `shipment_label` in the injected solution does not correspond to a request shipment, the corresponding visit is removed from the solution. If a SkippedShipment.label in the injected solution does not correspond to a request shipment, the `SkippedShipment` is removed from the solution. Removing route visits or entire routes from an injected solution may have an effect on the implied constraints, which may lead to change in solution, validation errors, or infeasibility. NOTE: The caller must ensure that each Vehicle.label (resp. Shipment.label) uniquely identifies a vehicle (resp. shipment) entity used across the two relevant requests: the past request that produced the `OptimizeToursResponse` used in the injected solution and the current request that includes the injected solution. The uniqueness checks described above are not enough to guarantee this requirement. type boolean label description Label that may be used to identify this request, reported back in the OptimizeToursResponse.request_label. type string maxValidationErrors description Truncates the number of validation errors returned. These errors are typically attached to an INVALID_ARGUMENT error payload as a BadRequest error detail (https://cloud.google.com/apis/design/errors#error_details), unless solving_mode=VALIDATE_ONLY: see the OptimizeToursResponse.validation_errors field. This defaults to 100 and is capped at 10,000. format int32 type integer model $ref GoogleCloudOptimizationV1ShipmentModel description Shipment model to solve. parent description Required. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. type string populatePolylines description If true, polylines will be populated in response `ShipmentRoute`s. type boolean populateTransitionPolylines description If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated `travel_steps`. type boolean populateTravelStepPolylines deprecated True description Deprecated: Use OptimizeToursRequest.populate_transition_polylines instead. If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated `travel_steps`. type boolean refreshDetailsRoutes description If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated. This does not solve the model. As of 2020/11, this only populates the polylines of non-empty routes and requires that `populate_polylines` is true. The `route_polyline` fields of the passed-in routes may be inconsistent with route `transitions`. This field must not be used together with `injected_first_solution_routes` or `injected_solution_constraint`. `Shipment.ignore` and `Vehicle.ignore` have no effect on the behavior. Polylines are still populated between all visits in all non-empty routes regardless of whether the related shipments or vehicles are ignored. items $ref GoogleCloudOptimizationV1ShipmentRoute type array searchMode description Search mode used to solve the request. enum SEARCH_MODE_UNSPECIFIED RETURN_FAST CONSUME_ALL_AVAILABLE_TIME enumDescriptions Unspecified search mode, equivalent to `RETURN_FAST`. Stop the search after finding the first good solution. Spend all the available time to search for better solutions. type string solvingMode description By default, the solving mode is `DEFAULT_SOLVE` (0). enum DEFAULT_SOLVE VALIDATE_ONLY DETECT_SOME_INFEASIBLE_SHIPMENTS enumDescriptions Solve the model. Warnings may be issued in OptimizeToursResponse.validation_errors. Only validates the model without solving it: populates as many OptimizeToursResponse.validation_errors as possible. Only populates OptimizeToursResponse.validation_errors or OptimizeToursResponse.skipped_shipments, and doesn't actually solve the rest of the request (`status` and `routes` are unset in the response). If infeasibilities in `injected_solution_constraint` routes are detected they are populated in the OptimizeToursResponse.validation_errors field and OptimizeToursResponse.skipped_shipments is left empty. *IMPORTANT*: not all infeasible shipments are returned here, but only the ones that are detected as infeasible during preprocessing. type string timeout description If this timeout is set, the server returns a response before the timeout period has elapsed or the server deadline for synchronous requests is reached, whichever is sooner. For asynchronous requests, the server will generate a solution (if possible) before the timeout has elapsed. format google-duration type string useGeodesicDistances description If true, travel distances will be computed using geodesic distances instead of Google Maps distances, and travel times will be computed using geodesic distances with a speed defined by `geodesic_meters_per_second`. type boolean type object GoogleCloudOptimizationV1OptimizeToursResponse description Response after solving a tour optimization problem containing the routes followed by each vehicle, the shipments which have been skipped and the overall cost of the solution. id GoogleCloudOptimizationV1OptimizeToursResponse properties metrics $ref GoogleCloudOptimizationV1OptimizeToursResponseMetrics description Duration, distance and usage metrics for this solution. requestLabel description Copy of the OptimizeToursRequest.label, if a label was specified in the request. type string routes description Routes computed for each vehicle; the i-th route corresponds to the i-th vehicle in the model. items $ref GoogleCloudOptimizationV1ShipmentRoute type array skippedShipments description The list of all shipments skipped. items $ref GoogleCloudOptimizationV1SkippedShipment type array totalCost deprecated True description Deprecated: Use Metrics.total_cost instead. Total cost of the solution. This takes into account all costs: costs per per hour and travel hour, fixed vehicle costs, unperformed shipment penalty costs, global duration cost, etc. format double type number validationErrors description List of all the validation errors that we were able to detect independently. See the "MULTIPLE ERRORS" explanation for the OptimizeToursValidationError message. Instead of errors, this will include warnings in the case `solving_mode` is `DEFAULT_SOLVE`. items $ref GoogleCloudOptimizationV1OptimizeToursValidationError type array type object GoogleCloudOptimizationV1OptimizeToursResponseMetrics description Overall metrics, aggregated over all routes. id GoogleCloudOptimizationV1OptimizeToursResponseMetrics properties aggregatedRouteMetrics $ref GoogleCloudOptimizationV1AggregatedMetrics description Aggregated over the routes. Each metric is the sum (or max, for loads) over all ShipmentRoute.metrics fields of the same name. costs additionalProperties format double type number description Cost of the solution, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole solution. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the solution. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01. type object earliestVehicleStartTime description The earliest start time for a used vehicle, computed as the minimum over all used vehicles of ShipmentRoute.vehicle_start_time. format google-datetime type string latestVehicleEndTime description The latest end time for a used vehicle, computed as the maximum over all used vehicles of ShipmentRoute.vehicle_end_time. format google-datetime type string skippedMandatoryShipmentCount description Number of mandatory shipments skipped. format int32 type integer totalCost description Total cost of the solution. The sum of all values in the costs map. format double type number usedVehicleCount description Number of vehicles used. Note: if a vehicle route is empty and Vehicle.used_if_route_is_empty is true, the vehicle is considered used. format int32 type integer type object GoogleCloudOptimizationV1OptimizeToursValidationError description Describes an error or warning encountered when validating an `OptimizeToursRequest`. id GoogleCloudOptimizationV1OptimizeToursValidationError properties code description A validation error is defined by the pair (`code`, `display_name`) which are always present. Other fields (below) provide more context about the error. *MULTIPLE ERRORS*: When there are multiple errors, the validation process tries to output several of them. Much like a compiler, this is an imperfect process. Some validation errors will be "fatal", meaning that they stop the entire validation process. This is the case for `display_name="UNSPECIFIED"` errors, among others. Some may cause the validation process to skip other errors. *STABILITY*: `code` and `display_name` should be very stable. But new codes and display names may appear over time, which may cause a given (invalid) request to yield a different (`code`, `display_name`) pair because the new error hid the old one (see "MULTIPLE ERRORS"). format int32 type integer displayName description The error display name. type string errorMessage description Human-readable string describing the error. There is a 1:1 mapping between `code` and `error_message` (when code != "UNSPECIFIED"). *STABILITY*: Not stable: the error message associated to a given `code` may change (hopefully to clarify it) over time. Please rely on the `display_name` and `code` instead. type string fields description An error context may involve 0, 1 (most of the time) or more fields. For example, referring to vehicle #4 and shipment #2's first pickup can be done as follows: ``` fields { name: "vehicles" index: 4} fields { name: "shipments" index: 2 sub_field {name: "pickups" index: 0} } ``` Note, however, that the cardinality of `fields` should not change for a given error code. items $ref GoogleCloudOptimizationV1OptimizeToursValidationErrorFieldReference type array offendingValues description May contain the value(s) of the field(s). This is not always available. You should absolutely not rely on it and use it only for manual model debugging. type string type object GoogleCloudOptimizationV1OptimizeToursValidationErrorFieldReference description Specifies a context for the validation error. A `FieldReference` always refers to a given field in this file and follows the same hierarchical structure. For example, we may specify element #2 of `start_time_windows` of vehicle #5 using: ``` name: "vehicles" index: 5 sub_field { name: "end_time_windows" index: 2 } ``` We however omit top-level entities such as `OptimizeToursRequest` or `ShipmentModel` to avoid crowding the message. id GoogleCloudOptimizationV1OptimizeToursValidationErrorFieldReference properties index description Index of the field if repeated. format int32 type integer key description Key if the field is a map. type string name description Name of the field, e.g., "vehicles". type string subField $ref GoogleCloudOptimizationV1OptimizeToursValidationErrorFieldReference description Recursively nested sub-field, if needed. type object GoogleCloudOptimizationV1Optimizer description The optimizer that will run optimizations based on all vehicles and shipments within the workspace. Each optimization is triggered by a client call. When the optimizer runs an optimization, it will construct an `OptimizeToursRequest` behind the scenes with the most up-to-date entity information and other constraints, and generate a solution. The corresponding `OptimizeToursRequest` for each solution can be retrieved. id GoogleCloudOptimizationV1Optimizer properties displayName description The display name of the optimizer. It can be up to 63 characters long and use UTF-8 characters. type string filters $ref GoogleCloudOptimizationV1OptimizerFilters description Filters applied to an optimizer which are used as conditions to select a subset of entities to run the optimization. modelSpec $ref GoogleCloudOptimizationV1ModelSpec description The model spec that is used to formulate all `ShipmentModel`s in the optimizations run by this optimizer. name description The resource name of the optimizer. Format: `projects/{project}/locations/{location}/workspaces/{workspace}/Optimizers/{optimizer}` type string optimizeToursSpec $ref GoogleCloudOptimizationV1OptimizerOptimizeToursSpec description Spec used to configure the `OptimizeToursRequest` constructed by this optimizer. type object GoogleCloudOptimizationV1OptimizerFilters description Filter expressions that match a subset of the entities to optimize. For more information about filter syntax, see https://google.aip.dev/160. id GoogleCloudOptimizationV1OptimizerFilters properties shipmentFilter description Filter expression that matches a subset of the shipments to optimize. type string vehicleFilter description Filter expression that matches a subset of the vehicles to optimize. type string type object GoogleCloudOptimizationV1OptimizerOptimizeToursSpec description Spec used to configure the `OptimizeToursRequest` by the optimizer every time it runs an optimization. The fields matches their corresponding fields in `OptimizeToursRequest`. id GoogleCloudOptimizationV1OptimizerOptimizeToursSpec properties allowLargeDeadlineDespiteInterruptionRisk description If this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines) of up to 60 minutes. Otherwise, the maximum deadline is only 30 minutes. Note that long-lived requests have a significantly larger (but still small) risk of interruption. type boolean considerRoadTraffic description Consider traffic estimation in calculating `ShipmentRoute` fields Transition.travel_duration, Visit.start_time, and `vehicle_end_time`; in setting the ShipmentRoute.has_traffic_infeasibilities field, and in calculating the OptimizeToursResponse.total_cost field. type boolean geodesicMetersPerSecond description When `use_geodesic_distances` is true, this field must be set and defines the speed applied to compute travel times. Its value must be at least 1.0 meters/seconds. format double type number populatePolylines description If true, polylines will be populated in response `ShipmentRoute`s. type boolean populateTransitionPolylines description If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated `travel_steps`. type boolean searchMode description Search mode used to solve the request. enum SEARCH_MODE_UNSPECIFIED RETURN_FAST CONSUME_ALL_AVAILABLE_TIME enumDescriptions Unspecified search mode, equivalent to `RETURN_FAST`. Stop the search after finding the first good solution. Spend all the available time to search for better solutions. type string timeout description If this timeout is set, the server will generate a solution (if possible) before the timeout has elapsed. format google-duration type string useGeodesicDistances description If true, travel distances will be computed using geodesic distances instead of Google Maps distances, and travel times will be computed using geodesic distances with a speed defined by `geodesic_meters_per_second`. type boolean type object GoogleCloudOptimizationV1OutputConfig description The desired output location. id GoogleCloudOptimizationV1OutputConfig properties dataFormat description The output data format that used to store the results in Cloud Storage. enum DATA_FORMAT_UNSPECIFIED JSON STRING enumDescriptions Default value. Input data in json format. Input data in string format. type string gcsDestination $ref GoogleCloudOptimizationV1GcsDestination description The Google Cloud Storage location to write the output to. type object GoogleCloudOptimizationV1RetrieveInputResponse description The response message for `RetrieveInput` method. id GoogleCloudOptimizationV1RetrieveInputResponse properties optimizationRequest $ref GoogleCloudOptimizationV1OptimizeToursRequest description The input, i.e. `OptimizeToursRequest`, used by the optimizer to generate this solution. type object GoogleCloudOptimizationV1RouteCommitments description Information about the vehicle's execution of a route to be used in constraining the solution `ShipmentRoute` obtained from a re-optimization. In particular, specifies route start time (i.e., actual, not planned), actual past visit start times, and committed sequence of future visits. id GoogleCloudOptimizationV1RouteCommitments properties nextVisits description Visits that the vehicle is committed to doing next. These visits must not have `start_time` specified, but must be listed in the sequence that they are to be performed. items $ref GoogleCloudOptimizationV1RouteCommitmentsVisit type array pastVisits description Visits that the vehicle has actually started (not necessarily completed) in the past, including their `start_time`s. These visits must have `start_time` >= `route_start_time` and be in order of `start_time`. items $ref GoogleCloudOptimizationV1RouteCommitmentsVisit type array routeStartTime description The actual time when the vehicle started executing its route. This must only be specified if the vehicle has started its route. format google-datetime type string type object GoogleCloudOptimizationV1RouteCommitmentsVisit description Specifies a pickup or delivery visit of a particular `Shipment` and, optionally, its `start_time`, which should only be set if the visit has actually happened. id GoogleCloudOptimizationV1RouteCommitmentsVisit properties isPickup description If true, the visit corresponds to a pickup of a `Shipment`. Otherwise, it corresponds to a delivery. type boolean shipmentName description The resource name of the shipment. type string startTime description Leave unset for next_visits. format google-datetime type string visitRequestIndex description Index of `VisitRequest` in either the pickup or delivery field of the `Shipment`. format int32 type integer type object GoogleCloudOptimizationV1RouteModifiers description Encapsulates a set of optional conditions to satisfy when calculating vehicle routes. This is similar to `RouteModifiers` in the Google Maps Platform API; see: https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteModifiers. id GoogleCloudOptimizationV1RouteModifiers properties avoidFerries description Specifies whether to avoid ferries where reasonable. Preference will be given to routes not containing travel by ferries. Applies only to motorized travel modes. type boolean avoidHighways description Specifies whether to avoid highways where reasonable. Preference will be given to routes not containing highways. Applies only to motorized travel modes. type boolean avoidIndoor description Optional. Specifies whether to avoid navigating indoors where reasonable. Preference will be given to routes not containing indoor navigation. Applies only to the `WALKING` travel mode. type boolean avoidTolls description Specifies whether to avoid toll roads where reasonable. Preference will be given to routes not containing toll roads. Applies only to motorized travel modes. type boolean type object GoogleCloudOptimizationV1RunOptimizerMetadata description The long running operation metadata for `RunOptimizer` method. id GoogleCloudOptimizationV1RunOptimizerMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the current operation. enum STATE_UNSPECIFIED RUNNING SUCCEEDED FAILED enumDescriptions The default value. This value is used if the state is omitted. Request is being processed. The operation succeeded. The operation failed. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudOptimizationV1RunOptimizerRequest description The request message for `RunOptimizer` method. id GoogleCloudOptimizationV1RunOptimizerRequest properties type object GoogleCloudOptimizationV1RunOptimizerResponse description The response message for `RunOptimizer` method. id GoogleCloudOptimizationV1RunOptimizerResponse properties solution description The name of the solution for this optimization. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/solutions/{solution}" type string type object GoogleCloudOptimizationV1Shipment description The shipment of a single item, from one of its pickups to one of its deliveries. For the shipment to be considered as performed, a unique vehicle must visit one of its pickup locations (and decrease its spare capacities accordingly), then visit one of its delivery locations later on (and therefore re-increase its spare capacities accordingly). id GoogleCloudOptimizationV1Shipment properties allowedVehicleIndices description The set of vehicles that may perform this shipment. If empty, all vehicles may perform it. Vehicles are given by their index in the `ShipmentModel`'s `vehicles` list. items format int32 type integer type array allowedVehicleNames description The resource names of vehicles that may perform this shipment. If empty, all vehicles may perform it. This field is used in the stateful service only. items type string type array costsPerVehicle description Specifies the cost that is incurred when this shipment is delivered by each vehicle. If specified, it must have EITHER: * the same number of elements as `costs_per_vehicle_indices`. `costs_per_vehicle[i]` corresponds to vehicle `costs_per_vehicle_indices[i]` of the model. * the same number of elements as there are vehicles in the model. The i-th element corresponds to vehicle #i of the model. These costs must be in the same unit as `penalty_cost` and must not be negative. Leave this field empty, if there are no such costs. items format double type number type array costsPerVehicleIndices description Indices of the vehicles to which `costs_per_vehicle` applies. If non-empty, it must have the same number of elements as `costs_per_vehicle`. A vehicle index may not be specified more than once. If a vehicle is excluded from `costs_per_vehicle_indices`, its cost is zero. items format int32 type integer type array costsPerVehicleNames description Resource names of the vehicles to which `costs_per_vehicle` applies. If non-empty, it must have the same number of elements as `costs_per_vehicle`. A name must not be specified more than once. If a vehicle is excluded from `costs_per_vehicle_names`, its cost is zero. items type string type array deliveries description Set of delivery alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the pickups. items $ref GoogleCloudOptimizationV1ShipmentVisitRequest type array demands deprecated True description Deprecated: Use Shipment.load_demands instead. items $ref GoogleCloudOptimizationV1CapacityQuantity type array displayName description The user-defined display name of the shipment. It can be up to 63 characters long and may use UTF-8 characters. type string ignore description If true, skip this shipment, but don't apply a `penalty_cost`. Ignoring a shipment results in a validation error when there are any `shipment_type_requirements` in the model. Ignoring a shipment that is performed in `injected_first_solution_routes` or `injected_solution_constraint` is permitted; the solver removes the related pickup/delivery visits from the performing route. `precedence_rules` that reference ignored shipments will also be ignored. type boolean label description Specifies a label for this shipment. This label is reported in the response in the `shipment_label` of the corresponding ShipmentRoute.Visit. type string loadDemands additionalProperties $ref GoogleCloudOptimizationV1ShipmentLoad description Load demands of the shipment (for example weight, volume, number of pallets etc). The keys in the map should be identifiers describing the type of the corresponding load, ideally also including the units. For example: "weight_kg", "volume_gallons", "pallet_count", etc. If a given key does not appear in the map, the corresponding load is considered as null. type object name description The resource name of the shipment. This is a unique identifier. Format: `projects/{project}/locations/{location}/workspaces/{workspace}/shipments/{shipment}` This field would be ignored while calling `OptimizeTours` and `BatchOptimizeTours` methods. type string penaltyCost description If the shipment is not completed, this penalty is added to the overall cost of the routes. A shipment is considered completed if one of its pickup and delivery alternatives is visited. The cost may be expressed in the same unit used for all other cost-related fields in the model and must be positive. *IMPORTANT*: If this penalty is not specified, it is considered infinite, i.e. the shipment must be completed. format double type number pickupToDeliveryAbsoluteDetourLimit description Specifies the maximum absolute detour time compared to the shortest path from pickup to delivery. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery. For example, let t be the shortest time taken to go from the selected pickup alternative directly to the selected delivery alternative. Then setting `pickup_to_delivery_absolute_detour_limit` enforces: ``` start_time(delivery) - start_time(pickup) <= t + pickup_to_delivery_absolute_detour_limit ``` If both relative and absolute limits are specified on the same shipment, the more constraining limit is used for each possible pickup/delivery pair. As of 2017/10, detours are only supported when travel durations do not depend on vehicles. format google-duration type string pickupToDeliveryRelativeDetourLimit description Specifies the maximum relative detour time compared to the shortest path from pickup to delivery. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery. For example, let t be the shortest time taken to go from the selected pickup alternative directly to the selected delivery alternative. Then setting `pickup_to_delivery_relative_detour_limit` enforces: ``` start_time(delivery) - start_time(pickup) <= std::ceil(t * (1.0 + pickup_to_delivery_relative_detour_limit)) ``` If both relative and absolute limits are specified on the same shipment, the more constraining limit is used for each possible pickup/delivery pair. As of 2017/10, detours are only supported when travel durations do not depend on vehicles. format double type number pickupToDeliveryTimeLimit description Specifies the maximum duration from start of pickup to start of delivery of a shipment. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery. This does not depend on which alternatives are selected for pickup and delivery, nor on vehicle speed. This can be specified alongside maximum detour constraints: the solution will respect both specifications. format google-duration type string pickups description Set of pickup alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the deliveries. items $ref GoogleCloudOptimizationV1ShipmentVisitRequest type array shipmentType description Non-empty string specifying a "type" for this shipment. This feature can be used to define incompatibilities or requirements between `shipment_types` (see `shipment_type_incompatibilities` and `shipment_type_requirements` in `ShipmentModel`). Differs from `visit_types` which is specified for a single visit: All pickup/deliveries belonging to the same shipment share the same `shipment_type`. type string type object GoogleCloudOptimizationV1ShipmentLoad description When performing a visit, a predefined amount may be added to the vehicle load if it's a pickup, or subtracted if it's a delivery. This message defines such amount. See load_demands. id GoogleCloudOptimizationV1ShipmentLoad properties amount description The amount by which the load of the vehicle performing the corresponding visit will vary. Since it is an integer, users are advised to choose an appropriate unit to avoid loss of precision. Must be ≥ 0. format int64 type string type object GoogleCloudOptimizationV1ShipmentModel description A shipment model contains a set of shipments which must be performed by a set of vehicles, while minimizing the overall cost, which is the sum of: * the cost of routing the vehicles (sum of cost per total time, cost per travel time, and fixed cost over all vehicles). * the unperformed shipment penalties. * the cost of the global duration of the shipments id GoogleCloudOptimizationV1ShipmentModel properties breakRules deprecated True description Deprecated: No longer used. Set of break rules used in the model. Each vehicle specifies the `BreakRule` that applies to it via the Vehicle.break_rule_indices field (which must be a singleton). items $ref GoogleCloudOptimizationV1ShipmentModelBreakRule type array durationDistanceMatrices description Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the `use_geodesic_distances` field. If it is not empty, `use_geodesic_distances` cannot be true and neither `duration_distance_matrix_src_tags` nor `duration_distance_matrix_dst_tags` can be empty. Usage examples: * There are two locations: locA and locB. * 1 vehicle starting its route at locA and ending it at locA. * 1 pickup visit request at locB. ``` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } } ``` * There are three locations: locA, locB and locC. * 1 vehicle starting its route at locA and ending it at locB, using matrix "fast". * 1 vehicle starting its route at locB and ending it at locB, using matrix "slow". * 1 vehicle starting its route at locB and ending it at locB, using matrix "fast". * 1 pickup visit request at locC. ``` model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } ``` items $ref GoogleCloudOptimizationV1ShipmentModelDurationDistanceMatrix type array durationDistanceMatrixDstTags description Tags defining the destinations of the duration and distance matrices; `duration_distance_matrices(i).rows(j).durations(k)` (resp. `duration_distance_matrices(i).rows(j).meters(k))` defines the duration (resp. the distance) of the travel from visits with tag `duration_distance_matrix_src_tags(j)` to visits with tag `duration_distance_matrix_dst_tags(k)` in matrix i. Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given `VisitRequest` or `Vehicle` must match exactly one tag in this field. Note that a `Vehicle`'s source, destination and matrix tags may be the same; similarly a `VisitRequest`'s source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then `duration_distance_matrices` must not be empty. items type string type array durationDistanceMatrixSrcTags description Tags defining the sources of the duration and distance matrices; `duration_distance_matrices(i).rows(j)` defines durations and distances from visits with tag `duration_distance_matrix_src_tags(j)` to other visits in matrix i. Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given `VisitRequest` or `Vehicle` must match exactly one tag in this field. Note that a `Vehicle`'s source, destination and matrix tags may be the same; similarly a `VisitRequest`'s source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then `duration_distance_matrices` must not be empty. items type string type array globalDurationCostPerHour description The "global duration" of the overall plan is the difference between the earliest effective start time and the latest effective end time of all vehicles. Users can assign a cost per hour to that quantity to try and optimize for earliest job completion, for example. This cost must be in the same unit as Shipment.penalty_cost. format double type number globalEndTime description If unset, 00:00:00 UTC, January 1, 1971 (i.e. seconds: 31536000, nanos: 0) is used as default. format google-datetime type string globalStartTime description Global start and end time of the model: no times outside of this range can be considered valid. The model's time span must be less than a year, i.e. the `global_end_time` and the `global_start_time` must be within 31536000 seconds of each other. When using `cost_per_*hour` fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (i.e. seconds: 0, nanos: 0) is used as default. format google-datetime type string maxActiveVehicles description Constrains the maximum number of active vehicles. A vehicle is active if its route performs at least one shipment. This can be used to limit the number of routes in the case where there are fewer drivers than vehicles and that the fleet of vehicles is heterogeneous. The optimization will then select the best subset of vehicles to use. Must be strictly positive. format int32 type integer precedenceRules description Set of precedence rules which must be enforced in the model. items $ref GoogleCloudOptimizationV1ShipmentModelPrecedenceRule type array shipmentTypeIncompatibilities description Sets of incompatible shipment_types (see `ShipmentTypeIncompatibility`). items $ref GoogleCloudOptimizationV1ShipmentTypeIncompatibility type array shipmentTypeRequirements description Sets of `shipment_type` requirements (see `ShipmentTypeRequirement`). items $ref GoogleCloudOptimizationV1ShipmentTypeRequirement type array shipments description Set of shipments which must be performed in the model. items $ref GoogleCloudOptimizationV1Shipment type array transitionAttributes description Transition attributes added to the model. items $ref GoogleCloudOptimizationV1TransitionAttributes type array vehicles description Set of vehicles which can be used to perform visits. items $ref GoogleCloudOptimizationV1Vehicle type array type object GoogleCloudOptimizationV1ShipmentModelBreakRule deprecated True description Deprecated: Use top level BreakRule instead. Rules to generate time breaks for a vehicle (e.g. lunch breaks). A break is a contiguous period of time during which the vehicle remains idle at its current position and cannot perform any visit. A break may occur: * during the travel between two visits (which includes the time right before or right after a visit, but not in the middle of a visit), in which case it extends the corresponding transit time between the visits * before the vehicle start (the vehicle may not start in the middle of a break), in which case it does not affect the vehicle start time. * after the vehicle end (ditto, with the vehicle end time). id GoogleCloudOptimizationV1ShipmentModelBreakRule properties breakRequests description Sequence of breaks. See the `BreakRequest` message. items $ref GoogleCloudOptimizationV1ShipmentModelBreakRuleBreakRequest type array frequencyConstraints description Several `FrequencyConstraint` may apply. They must all be satisfied by the `BreakRequest`s of this `BreakRule`. See `FrequencyConstraint`. items $ref GoogleCloudOptimizationV1ShipmentModelBreakRuleFrequencyConstraint type array type object GoogleCloudOptimizationV1ShipmentModelBreakRuleBreakRequest description The sequence of breaks (i.e. their number and order) that apply to each vehicle must be known beforehand. The repeated `BreakRequest`s define that sequence, in the order in which they must occur. Their time windows (`earliest_start_time` / `latest_start_time`) may overlap, but they must be compatible with the order (this is checked). id GoogleCloudOptimizationV1ShipmentModelBreakRuleBreakRequest properties earliestStartTime description Required. Lower bound (inclusive) on the start of the break. format google-datetime type string latestStartTime description Required. Upper bound (inclusive) on the start of the break. format google-datetime type string minDuration description Required. Minimum duration of the break. Must be positive. format google-duration type string type object GoogleCloudOptimizationV1ShipmentModelBreakRuleFrequencyConstraint description One may further constrain the frequency and duration of the breaks specified above, by enforcing a minimum break frequency, such as "There must be a break of at least 1 hour every 12 hours". Assuming that this can be interpreted as "Within any sliding time window of 12h, there must be at least one break of at least one hour", that example would translate to the following `FrequencyConstraint`: ``` { min_break_duration { seconds: 3600 } # 1 hour. max_inter_break_duration { seconds: 39600 } # 11 hours (12 - 1 = 11). } ``` The timing and duration of the breaks in the solution will respect all such constraints, in addition to the time windows and minimum durations already specified in the `BreakRequest`. A `FrequencyConstraint` may in practice apply to non-consecutive breaks. For example, the following schedule honors the "1h every 12h" example: ``` 04:00 vehicle start .. performing travel and visits .. 09:00 1 hour break 10:00 end of the break .. performing travel and visits .. 12:00 20-min lunch break 12:20 end of the break .. performing travel and visits .. 21:00 1 hour break 22:00 end of the break .. performing travel and visits .. 23:59 vehicle end ``` id GoogleCloudOptimizationV1ShipmentModelBreakRuleFrequencyConstraint properties maxInterBreakDuration description Required. Maximum allowed span of any interval of time in the route that does not include at least partially a break of `duration >= min_break_duration`. Must be positive. format google-duration type string minBreakDuration description Required. Minimum break duration for this constraint. Nonnegative. See description of `FrequencyConstraint`. format google-duration type string type object GoogleCloudOptimizationV1ShipmentModelDurationDistanceMatrix description Specifies a duration and distance matrix from visit and vehicle start locations to visit and vehicle end locations. id GoogleCloudOptimizationV1ShipmentModelDurationDistanceMatrix properties rows description Specifies the rows of the duration and distance matrix. It must have as many elements as ShipmentModel.duration_distance_matrix_src_tags. items $ref GoogleCloudOptimizationV1ShipmentModelDurationDistanceMatrixRow type array vehicleStartTag description Tag defining to which vehicles this duration and distance matrix applies. If empty, this applies to all vehicles, and there can only be a single matrix. Each vehicle start must match exactly one matrix, i.e. exactly one of their `start_tags` field must match the `vehicle_start_tag` of a matrix (and of that matrix only). All matrices must have a different `vehicle_start_tag`. type string type object GoogleCloudOptimizationV1ShipmentModelDurationDistanceMatrixRow description Specifies a row of the duration and distance matrix. id GoogleCloudOptimizationV1ShipmentModelDurationDistanceMatrixRow properties durations description Duration values for a given row. It must have as many elements as ShipmentModel.duration_distance_matrix_dst_tags. items format google-duration type string type array meters description Distance values for a given row. If no costs or constraints refer to distances in the model, this can be left empty; otherwise it must have as many elements as `durations`. items format double type number type array type object GoogleCloudOptimizationV1ShipmentModelPrecedenceRule description A precedence rule between two events (each event is the pickup or the delivery of a shipment): the "second" event has to start at least `offset_duration` after "first" has started. Several precedences can refer to the same (or related) events, e.g., "pickup of B happens after delivery of A" and "pickup of C happens after pickup of B". Furthermore, precedences only apply when both shipments are performed and are otherwise ignored. id GoogleCloudOptimizationV1ShipmentModelPrecedenceRule properties firstIndex description Shipment index of the "first" event. This field must be specified. format int32 type integer firstIsDelivery description Indicates if the "first" event is a delivery. type boolean offsetDuration description The offset between the "first" and "second" event. It can be negative. format google-duration type string secondIndex description Shipment index of the "second" event. This field must be specified. format int32 type integer secondIsDelivery description Indicates if the "second" event is a delivery. type boolean type object GoogleCloudOptimizationV1ShipmentRoute description A vehicle's route can be decomposed, along the time axis, like this (we assume there are n visits): ``` | | | | | T[2], | | | | Transition | Visit #0 | | | V[2], | | | | #0 | aka | T[1] | V[1] | ... | V[n-1] | T[n] | | aka T[0] | V[0] | | | V[n-2],| | | | | | | | T[n-1] | | | ^ ^ ^ ^ ^ ^ ^ ^ vehicle V[0].start V[0].end V[1]. V[1]. V[n]. V[n]. vehicle start (arrival) (departure) start end start end end ``` Note that we make a difference between: * "punctual events", such as the vehicle start and end and each visit's start and end (aka arrival and departure). They happen at a given second. * "time intervals", such as the visits themselves, and the transition between visits. Though time intervals can sometimes have zero duration, i.e. start and end at the same second, they often have a positive duration. Invariants: * If there are n visits, there are n+1 transitions. * A visit is always surrounded by a transition before it (same index) and a transition after it (index + 1). * The vehicle start is always followed by transition #0. * The vehicle end is always preceded by transition #n. Zooming in, here is what happens during a `Transition` and a `Visit`: ``` ---+-------------------------------------+-----------------------------+--> | TRANSITION[i] | VISIT[i] | | | | | * TRAVEL: the vehicle moves from | PERFORM the visit: | | VISIT[i-1].departure_location to | | | VISIT[i].arrival_location, which | * Spend some time: | | takes a given travel duration | the "visit duration". | | and distance | | | | * Load or unload | | * BREAKS: the driver may have | some quantities from the | | breaks (e.g. lunch break). | vehicle: the "demand". | | | | | * WAIT: the driver/vehicle does | | | nothing. This can happen for | | | many reasons, for example when | | | the vehicle reaches the next | | | event's destination before the | | | start of its time window | | | | | | * DELAY: *right before* the next | | | arrival. E.g. the vehicle and/or | | | driver spends time unloading. | | | | | ---+-------------------------------------+-----------------------------+--> ^ ^ ^ V[i-1].end V[i].start V[i].end ``` Lastly, here is how the TRAVEL, BREAKS, DELAY and WAIT can be arranged during a transition. * They don't overlap. * The DELAY is unique and *must* be a contiguous period of time right before the next visit (or vehicle end). Thus, it suffice to know the delay duration to know its start and end time. * The BREAKS are contiguous, non-overlapping periods of time. The response specifies the start time and duration of each break. * TRAVEL and WAIT are "preemptable": they can be interrupted several times during this transition. Clients can assume that travel happens "as soon as possible" and that "wait" fills the remaining time. A (complex) example: ``` TRANSITION[i] --++-----+-----------------------------------------------------------++--> || | | | | | | || || T | B | T | | B | | D || || r | r | r | W | r | W | e || || a | e | a | a | e | a | l || || v | a | v | i | a | i | a || || e | k | e | t | k | t | y || || l | | l | | | | || || | | | | | | || --++-----------------------------------------------------------------++--> ``` id GoogleCloudOptimizationV1ShipmentRoute properties breaks description Breaks scheduled for the vehicle performing this route. The `breaks` sequence represents time intervals, each starting at the corresponding `start_time` and lasting `duration` seconds. items $ref GoogleCloudOptimizationV1ShipmentRouteBreak type array delayBeforeVehicleEnd $ref GoogleCloudOptimizationV1ShipmentRouteDelay deprecated True description Deprecated: Delay occurring before the vehicle end. See TransitionAttributes.delay. endLoads deprecated True description Deprecated: Use Transition.vehicle_loads instead. Vehicle loads upon arrival at its end location, for each type specified in Vehicle.capacities, `start_load_intervals`, `end_load_intervals` or demands. Exception: we omit loads for quantity types unconstrained by intervals and that don't have any non-zero demand on the route. items $ref GoogleCloudOptimizationV1CapacityQuantity type array hasTrafficInfeasibilities description When OptimizeToursRequest.consider_road_traffic, is set to true, this field indicates that inconsistencies in route timings are predicted using traffic-based travel duration estimates. There may be insufficient time to complete traffic-adjusted travel, delays, and breaks between visits, before the first visit, or after the last visit, while still satisfying the visit and vehicle time windows. For example, ``` start_time(previous_visit) + duration(previous_visit) + travel_duration(previous_visit, next_visit) > start_time(next_visit) ``` Arrival at next_visit will likely happen later than its current time window due the increased estimate of travel time `travel_duration(previous_visit, next_visit)` due to traffic. Also, a break may be forced to overlap with a visit due to an increase in travel time estimates and visit or break time window restrictions. type boolean metrics $ref GoogleCloudOptimizationV1AggregatedMetrics description Duration, distance and load metrics for this route. The fields of AggregatedMetrics are summed over all ShipmentRoute.transitions or ShipmentRoute.visits, depending on the context. routeCosts additionalProperties format double type number description Cost of the route, broken down by cost-related request fields. The keys are proto paths, relative to the input OptimizeToursRequest, e.g. "model.shipments.pickups.cost", and the values are the total cost generated by the corresponding cost field, aggregated over the whole route. In other words, costs["model.shipments.pickups.cost"] is the sum of all pickup costs over the route. All costs defined in the model are reported in detail here with the exception of costs related to TransitionAttributes that are only reported in an aggregated way as of 2022/01. type object routePolyline $ref GoogleCloudOptimizationV1ShipmentRouteEncodedPolyline description The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true. routeTotalCost description Total cost of the route. The sum of all costs in the cost map. format double type number transitions description Ordered list of transitions for the route. items $ref GoogleCloudOptimizationV1ShipmentRouteTransition type array travelSteps deprecated True description Deprecated: Use ShipmentRoute.transitions instead. Ordered list of travel steps for the route. items $ref GoogleCloudOptimizationV1ShipmentRouteTravelStep type array vehicleDetour deprecated True description Deprecated: No longer used. This field will only be populated at the ShipmentRoute.Visit level. This field is the extra detour time due to the shipments visited on the route. It is equal to `vehicle_end_time` - `vehicle_start_time` - travel duration from the vehicle's start_location to its `end_location`. format google-duration type string vehicleEndTime description Time at which the vehicle finishes its route. format google-datetime type string vehicleIndex description Vehicle performing the route, identified by its index in the source `ShipmentModel`. format int32 type integer vehicleLabel description Label of the vehicle performing this route, equal to `ShipmentModel.vehicles(vehicle_index).label`, if specified. type string vehicleName description Name of the vehicle performing this route. It is used in the stateful service only. type string vehicleStartTime description Time at which the vehicle starts its route. format google-datetime type string visits description Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused. items $ref GoogleCloudOptimizationV1ShipmentRouteVisit type array type object GoogleCloudOptimizationV1ShipmentRouteBreak description Data representing the execution of a break. id GoogleCloudOptimizationV1ShipmentRouteBreak properties duration description Duration of a break. format google-duration type string startTime description Start time of a break. format google-datetime type string type object GoogleCloudOptimizationV1ShipmentRouteDelay deprecated True description Deprecated: Use ShipmentRoute.Transition.delay_duration instead. Time interval spent on the route resulting from a TransitionAttributes.delay. id GoogleCloudOptimizationV1ShipmentRouteDelay properties duration description Duration of the delay. format google-duration type string startTime description Start of the delay. format google-datetime type string type object GoogleCloudOptimizationV1ShipmentRouteEncodedPolyline description The encoded representation of a polyline. More information on polyline encoding can be found here: https://developers.google.com/maps/documentation/utilities/polylinealgorithm https://developers.google.com/maps/documentation/javascript/reference/geometry#encoding. id GoogleCloudOptimizationV1ShipmentRouteEncodedPolyline properties points description String representing encoded points of the polyline. type string type object GoogleCloudOptimizationV1ShipmentRouteTransition description Transition between two events on the route. See the description of ShipmentRoute. If the vehicle does not have a `start_location` and/or `end_location`, the corresponding travel metrics are 0. id GoogleCloudOptimizationV1ShipmentRouteTransition properties breakDuration description Sum of the duration of the breaks occurring during this transition, if any. Details about each break's start time and duration are stored in ShipmentRoute.breaks. format google-duration type string delayDuration description Sum of the delay durations applied to this transition. If any, the delay starts exactly `delay_duration` seconds before the next event (visit or vehicle end). See TransitionAttributes.delay. format google-duration type string loads deprecated True description Deprecated: Use Transition.vehicle_loads instead. items $ref GoogleCloudOptimizationV1CapacityQuantity type array routePolyline $ref GoogleCloudOptimizationV1ShipmentRouteEncodedPolyline description The encoded polyline representation of the route followed during the transition. This field is only populated if populate_transition_polylines is set to true. startTime description Start time of this transition. format google-datetime type string totalDuration description Total duration of the transition, provided for convenience. It is equal to: * next visit `start_time` (or `vehicle_end_time` if this is the last transition) - this transition's `start_time`; * if `ShipmentRoute.has_traffic_infeasibilities` is false, the following additionally holds: `total_duration = travel_duration + delay_duration + break_duration + wait_duration`. format google-duration type string trafficInfoUnavailable description When traffic is requested via OptimizeToursRequest.consider_road_traffic, and the traffic info couldn't be retrieved for a `Transition`, this boolean is set to true. This may be temporary (rare hiccup in the realtime traffic servers) or permanent (no data for this location). type boolean travelDistanceMeters description Distance traveled during the transition. format double type number travelDuration description Travel duration during this transition. format google-duration type string vehicleLoads additionalProperties $ref GoogleCloudOptimizationV1ShipmentRouteVehicleLoad description Vehicle loads during this transition, for each type that either appears in this vehicle's Vehicle.load_limits, or that have non-zero Shipment.load_demands on some shipment performed on this route. The loads during the first transition are the starting loads of the vehicle route. Then, after each visit, the visit's `load_demands` are either added or subtracted to get the next transition's loads, depending on whether the visit was a pickup or a delivery. type object waitDuration description Time spent waiting during this transition. Wait duration corresponds to idle time and does not include break time. Also note that this wait time may be split into several non-contiguous intervals. format google-duration type string type object GoogleCloudOptimizationV1ShipmentRouteTravelStep deprecated True description Deprecated: Use ShipmentRoute.Transition instead. Travel between each visit along the route: from the vehicle's `start_location` to the first visit's `arrival_location`, then from the first visit's `departure_location` to the second visit's `arrival_location`, and so on until the vehicle's `end_location`. This accounts only for the actual travel between visits, not counting the waiting time, the time spent performing a visit, nor the distance covered during a visit. Invariant: `travel_steps_size() == visits_size() + 1`. If the vehicle does not have a start_ and/or end_location, the corresponding travel metrics are 0 and/or empty. id GoogleCloudOptimizationV1ShipmentRouteTravelStep properties distanceMeters description Distance traveled during the step. format double type number duration description Duration of the travel step. format google-duration type string routePolyline $ref GoogleCloudOptimizationV1ShipmentRouteEncodedPolyline description The encoded polyline representation of the route followed during the step. This field is only populated if OptimizeToursRequest.populate_travel_step_polylines is set to true. trafficInfoUnavailable description When traffic is requested via OptimizeToursRequest.consider_road_traffic, and the traffic info couldn't be retrieved for a TravelStep, this boolean is set to true. This may be temporary (rare hiccup in the realtime traffic servers) or permanent (no data for this location). type boolean type object GoogleCloudOptimizationV1ShipmentRouteVehicleLoad description Reports the actual load of the vehicle at some point along the route, for a given type (see Transition.vehicle_loads). id GoogleCloudOptimizationV1ShipmentRouteVehicleLoad properties amount description The amount of load on the vehicle, for the given type. The unit of load is usually indicated by the type. See Transition.vehicle_loads. format int64 type string type object GoogleCloudOptimizationV1ShipmentRouteVisit description A visit performed during a route. This visit corresponds to a pickup or a delivery of a `Shipment`. id GoogleCloudOptimizationV1ShipmentRouteVisit properties arrivalLoads deprecated True description Deprecated: Use Transition.vehicle_loads instead. Vehicle loads upon arrival at the visit location, for each type specified in Vehicle.capacities, `start_load_intervals`, `end_load_intervals` or `demands`. Exception: we omit loads for quantity types unconstrained by intervals and that don't have any non-zero demand on the route. items $ref GoogleCloudOptimizationV1CapacityQuantity type array delayBeforeStart $ref GoogleCloudOptimizationV1ShipmentRouteDelay deprecated True description Deprecated: Use ShipmentRoute.Transition.delay_duration instead. Delay occurring before the visit starts. demands deprecated True description Deprecated: Use Visit.load_demands instead. items $ref GoogleCloudOptimizationV1CapacityQuantity type array detour description Extra detour time due to the shipments visited on the route before the visit and to the potential waiting time induced by time windows. If the visit is a delivery, the detour is computed from the corresponding pickup visit and is equal to: ``` start_time(delivery) - start_time(pickup) - (duration(pickup) + travel duration from the pickup location to the delivery location). ``` Otherwise, it is computed from the vehicle `start_location` and is equal to: ``` start_time - vehicle_start_time - travel duration from the vehicle's `start_location` to the visit. ``` format google-duration type string isPickup description If true the visit corresponds to a pickup of a `Shipment`. Otherwise, it corresponds to a delivery. type boolean loadDemands additionalProperties $ref GoogleCloudOptimizationV1ShipmentLoad description Total visit load demand as the sum of the shipment and the visit request `load_demands`. The values are negative if the visit is a delivery. Demands are reported for the same types as the Transition.loads (see this field). type object shipmentIndex description Index of the `shipments` field in the source ShipmentModel. format int32 type integer shipmentLabel description Copy of the corresponding `Shipment.label`, if specified in the `Shipment`. type string shipmentName description Name of the `shipment`. It is used in the stateful service only. type string startTime description Time at which the visit starts. Note that the vehicle may arrive earlier than this at the visit location. Times are consistent with the `ShipmentModel`. format google-datetime type string visitLabel description Copy of the corresponding VisitRequest.label, if specified in the `VisitRequest`. type string visitRequestIndex description Index of `VisitRequest` in either the pickup or delivery field of the `Shipment` (see `is_pickup`). format int32 type integer type object GoogleCloudOptimizationV1ShipmentTypeIncompatibility description Specifies incompatibilties between shipments depending on their shipment_type. The appearance of incompatible shipments on the same route is restricted based on the incompatibility mode. id GoogleCloudOptimizationV1ShipmentTypeIncompatibility properties incompatibilityMode description Mode applied to the incompatibility. enum INCOMPATIBILITY_MODE_UNSPECIFIED NOT_PERFORMED_BY_SAME_VEHICLE NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY enumDescriptions Unspecified incompatibility mode. This value should never be used. In this mode, two shipments with incompatible types can never share the same vehicle. For two shipments with incompatible types with the `NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY` incompatibility mode: * If both are pickups only (no deliveries) or deliveries only (no pickups), they cannot share the same vehicle at all. * If one of the shipments has a delivery and the other a pickup, the two shipments can share the same vehicle iff the former shipment is delivered before the latter is picked up. type string types description List of incompatible types. Two shipments having different `shipment_types` among those listed are "incompatible". items type string type array type object GoogleCloudOptimizationV1ShipmentTypeRequirement description Specifies requirements between shipments based on their shipment_type. The specifics of the requirement are defined by the requirement mode. id GoogleCloudOptimizationV1ShipmentTypeRequirement properties dependentShipmentTypes description All shipments with a type in the `dependent_shipment_types` field require at least one shipment of type `required_shipment_type_alternatives` to be visited on the same route. NOTE: Chains of requirements such that a `shipment_type` depends on itself are not allowed. items type string type array requiredShipmentTypeAlternatives description List of alternative shipment types required by the `dependent_shipment_types`. items type string type array requirementMode description Mode applied to the requirement. enum REQUIREMENT_MODE_UNSPECIFIED PERFORMED_BY_SAME_VEHICLE IN_SAME_VEHICLE_AT_PICKUP_TIME IN_SAME_VEHICLE_AT_DELIVERY_TIME enumDescriptions Unspecified requirement mode. This value should never be used. In this mode, all "dependent" shipments must share the same vehicle as at least one of their "required" shipments. With the `IN_SAME_VEHICLE_AT_PICKUP_TIME` mode, all "dependent" shipments need to have at least one "required" shipment on their vehicle at the time of their pickup. A "dependent" shipment pickup must therefore have either: * A delivery-only "required" shipment delivered on the route after, or * A "required" shipment picked up on the route before it, and if the "required" shipment has a delivery, this delivery must be performed after the "dependent" shipment's pickup. Same as before, except the "dependent" shipments need to have a "required" shipment on their vehicle at the time of their *delivery*. type string type object GoogleCloudOptimizationV1ShipmentVisitRequest description Request for a visit which can be done by a vehicle: it has a geo-location (or two, see below), opening and closing times represented by time windows, and a service duration time (time spent by the vehicle once it has arrived to pickup or drop off goods). id GoogleCloudOptimizationV1ShipmentVisitRequest properties arrivalLocation $ref GoogleTypeLatLng description The geo-location where the vehicle arrives when performing this `VisitRequest`. If the shipment model has duration distance matrices, `arrival_location` must not be specified. arrivalWaypoint $ref GoogleCloudOptimizationV1Waypoint description The waypoint where the vehicle arrives when performing this `VisitRequest`. If the shipment model has duration distance matrices, `arrival_waypoint` must not be specified. cost description Cost to service this visit request on a vehicle route. This can be used to pay different costs for each alternative pickup or delivery of a shipment. This cost must be in the same unit as `Shipment.penalty_cost` and must not be negative. format double type number demands deprecated True description Deprecated: Use VisitRequest.load_demands instead. items $ref GoogleCloudOptimizationV1CapacityQuantity type array departureLocation $ref GoogleTypeLatLng description The geo-location where the vehicle departs after completing this `VisitRequest`. Can be omitted if it is the same as `arrival_location`. If the shipment model has duration distance matrices, `departure_location` must not be specified. departureWaypoint $ref GoogleCloudOptimizationV1Waypoint description The waypoint where the vehicle departs after completing this `VisitRequest`. Can be omitted if it is the same as `arrival_waypoint`. If the shipment model has duration distance matrices, `departure_waypoint` must not be specified. duration description Duration of the visit, i.e. time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see `time_windows`). format google-duration type string label description Specifies a label for this `VisitRequest`. This label is reported in the response as `visit_label` in the corresponding ShipmentRoute.Visit. type string loadDemands additionalProperties $ref GoogleCloudOptimizationV1ShipmentLoad description Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment. The demands listed here are added to the demands listed in Shipment.load_demands. type object tags description Specifies tags attached to the visit request. Empty or duplicate strings are not allowed. items type string type array timeWindows description Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before TimeWindow.start_time. The absence of `TimeWindow` means that the vehicle can perform this visit at any time. Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window. items $ref GoogleCloudOptimizationV1TimeWindow type array visitTypes description Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see Vehicle.extra_visit_duration_for_visit_type). A type can only appear once. items type string type array type object GoogleCloudOptimizationV1SkippedShipment description Specifies details of unperformed shipments in a solution. For trivial cases and/or if we are able to identify the cause for skipping, we report the reason here. id GoogleCloudOptimizationV1SkippedShipment properties index description The index corresponds to the index of the shipment in the source `ShipmentModel`. format int32 type integer label description Copy of the corresponding Shipment.label, if specified in the `Shipment`. type string reasons description A list of reasons that explain why the shipment was skipped. See comment above `Reason`. items $ref GoogleCloudOptimizationV1SkippedShipmentReason type array shipmentName description Name of the `shipment`. It is used in the stateful service only. type string type object GoogleCloudOptimizationV1SkippedShipmentReason description If we can explain why the shipment was skipped, reasons will be listed here. If the reason is not the same for all vehicles, `reason` will have more than 1 element. A skipped shipment cannot have duplicate reasons, i.e. where all fields are the same except for `example_vehicle_index`. Example: ``` reasons { code: DEMAND_EXCEEDS_VEHICLE_CAPACITY example_vehicle_index: 1 example_exceeded_capacity_type: "Apples" } reasons { code: DEMAND_EXCEEDS_VEHICLE_CAPACITY example_vehicle_index: 3 example_exceeded_capacity_type: "Pears" } reasons { code: CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT example_vehicle_index: 1 } ``` The skipped shipment is incompatible with all vehicles. The reasons may be different for all vehicles but at least one vehicle's "Apples" capacity would be exceeded (including vehicle 1), at least one vehicle's "Pears" capacity would be exceeded (including vehicle 3) and at least one vehicle's distance limit would be exceeded (including vehicle 1). id GoogleCloudOptimizationV1SkippedShipmentReason properties code description Refer to the comments of Code. enum CODE_UNSPECIFIED NO_VEHICLE DEMAND_EXCEEDS_VEHICLE_CAPACITY CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS VEHICLE_NOT_ALLOWED enumDescriptions This should never be used. If we are unable to understand why a shipment was skipped, we simply return an empty set of reasons. There is no vehicle in the model making all shipments infeasible. The demand of the shipment exceeds a vehicle's capacity for some capacity types, one of which is `example_exceeded_capacity_type`. The minimum distance necessary to perform this shipment, i.e. from the vehicle's `start_location` to the shipment's pickup and/or delivery locations and to the vehicle's end location exceeds the vehicle's `route_distance_limit`. Note that for this computation we use the geodesic distances. The minimum time necessary to perform this shipment, including travel time, wait time and service time exceeds the vehicle's `route_duration_limit`. Note: travel time is computed in the best-case scenario, namely as geodesic distance x 36 m/s (roughly 130 km/hour). Same as above but we only compare minimum travel time and the vehicle's `travel_duration_limit`. The vehicle cannot perform this shipment in the best-case scenario (see `CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT` for time computation) if it starts at its earliest start time: the total time would make the vehicle end after its latest end time. The `allowed_vehicle_indices` field of the shipment is not empty and this vehicle does not belong to it. type string exampleExceededCapacityType description If the reason code is `DEMAND_EXCEEDS_VEHICLE_CAPACITY`, documents one capacity type that is exceeded. type string exampleVehicleIndex description If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle. format int32 type integer exampleVehicleName description If the reason is related to a shipment-vehicle incompatibility, this field provides the resource name of one relevant vehicle. This field is used in the stateful service only. type string type object GoogleCloudOptimizationV1Solution description The solution contains planned routes and related metadata resulted from an optimization run. id GoogleCloudOptimizationV1Solution properties displayName description The display name of the solution. type string metadata $ref GoogleCloudOptimizationV1SolutionSolutionMetadata description The metadata for this solution. name description The resource name of the solution. Format: `projects/{project}/locations/{location}/workspaces/{workspace}/solutions/{solution}` type string optimizationResponse $ref GoogleCloudOptimizationV1OptimizeToursResponse description The core solution in the form of an `OptimizeToursResponse`, where: * `routes` refers to vehicles by their resource names; * `request_label` is ignored; * Deprecated fields are ignored. type object GoogleCloudOptimizationV1SolutionSolutionMetadata description Metadata for solutions. id GoogleCloudOptimizationV1SolutionSolutionMetadata properties optimizationStartTime description The timestamp that this run of optimization started. The changes of entities (e.g. shipments and vehicles) after this are not captured in generating this solution. format google-datetime type string optimizer description The name of the optimizer that generated this solution. type string type object GoogleCloudOptimizationV1TimeWindow description Time windows constrain the time of an event, such as the arrival time at a visit, or the start and end time of a vehicle. Hard time window bounds, `start_time` and `end_time`, enforce the earliest and latest time of the event, such that `start_time <= event_time <= end_time`. The soft time window lower bound, `soft_start_time`, expresses a preference for the event to happen at or after `soft_start_time` by incurring a cost proportional to how long before soft_start_time the event occurs. The soft time window upper bound, `soft_end_time`, expresses a preference for the event to happen at or before `soft_end_time` by incurring a cost proportional to how long after `soft_end_time` the event occurs. `start_time`, `end_time`, `soft_start_time` and `soft_end_time` should be within the global time limits (see ShipmentModel.global_start_time and ShipmentModel.global_end_time) and should respect: ``` 0 <= `start_time` <= `end_time` and 0 <= `start_time` <= `soft_start_time` and 0 <= `soft_end_time` <= `end_time`. ``` id GoogleCloudOptimizationV1TimeWindow properties costPerHourAfterSoftEndTime description A cost per hour added to other costs in the model if the event occurs after `soft_end_time`, computed as: ``` max(0, t.seconds - soft_end_time.seconds) * cost_per_hour_after_soft_end_time / 3600, t being the time of the event. ``` This cost must be positive, and the field can only be set if `soft_end_time` has been set. format double type number costPerHourBeforeSoftStartTime description A cost per hour added to other costs in the model if the event occurs before soft_start_time, computed as: ``` max(0, soft_start_time - t.seconds) * cost_per_hour_before_soft_start_time / 3600, t being the time of the event. ``` This cost must be positive, and the field can only be set if soft_start_time has been set. format double type number endTime description The hard time window end time. If unspecified it will be set to `ShipmentModel.global_end_time`. format google-datetime type string softEndTime description The soft end time of the time window. format google-datetime type string softStartTime description The soft start time of the time window. format google-datetime type string startTime description The hard time window start time. If unspecified it will be set to `ShipmentModel.global_start_time`. format google-datetime type string type object GoogleCloudOptimizationV1TransitionAttributes description Specifies attributes of transitions between two consecutive visits on a route. Several `TransitionAttributes` may apply to the same transition: in that case, all extra costs add up and the strictest constraint or limit applies (following natural "AND" semantics). id GoogleCloudOptimizationV1TransitionAttributes properties cost description Specifies a cost for performing this transition. This is in the same unit as all other costs in the model and must not be negative. It is applied on top of all other existing costs. format double type number costPerKilometer description Specifies a cost per kilometer applied to the distance traveled while performing this transition. It adds up to any Vehicle.cost_per_kilometer specified on vehicles. format double type number delay description Specifies a delay incurred when performing this transition. This delay always occurs *after* finishing the source visit and *before* starting the destination visit. format google-duration type string distanceLimit $ref GoogleCloudOptimizationV1DistanceLimit description Specifies a limit on the distance traveled while performing this transition. As of 2021/06, only soft limits are supported. dstTag description A destination visit or vehicle end matches iff its VisitRequest.tags or Vehicle.end_tags either contains `dst_tag` or does not contain `excluded_dst_tag` (depending on which of these two fields is non-empty). type string excludedDstTag description See `dst_tag`. Exactly one of `dst_tag` and `excluded_dst_tag` must be non-empty. type string excludedSrcTag description See `src_tag`. Exactly one of `src_tag` and `excluded_src_tag` must be non-empty. type string srcTag description Tags defining the set of (src->dst) transitions these attributes apply to. A source visit or vehicle start matches iff its VisitRequest.tags or Vehicle.start_tags either contains `src_tag` or does not contain `excluded_src_tag` (depending on which of these two fields is non-empty). type string type object GoogleCloudOptimizationV1Vehicle description Models a vehicle in a shipment problem. Solving a shipment problem will build a route starting from `start_location` and ending at `end_location` for this vehicle. A route is a sequence of visits (see `ShipmentRoute`). id GoogleCloudOptimizationV1Vehicle properties breakRule $ref GoogleCloudOptimizationV1BreakRule description Describes the break schedule to be enforced on this vehicle. If empty, no breaks will be scheduled for this vehicle. breakRuleIndices deprecated True description Deprecated: No longer used. Indices in the `break_rule` field in the source ShipmentModel. They correspond to break rules enforced on the vehicle. As of 2018/03, at most one rule index per vehicle can be specified. items format int32 type integer type array capacities deprecated True description Deprecated: Use Vehicle.load_limits instead. items $ref GoogleCloudOptimizationV1CapacityQuantity type array costPerHour description Vehicle costs: all costs add up and must be in the same unit as Shipment.penalty_cost. Cost per hour of the vehicle route. This cost is applied to the total time taken by the route, and includes travel time, waiting time, and visit time. Using `cost_per_hour` instead of just `cost_per_traveled_hour` may result in additional latency. format double type number costPerKilometer description Cost per kilometer of the vehicle route. This cost is applied to the distance reported in the ShipmentRoute.transitions and does not apply to any distance implicitly traveled from the `arrival_location` to the `departure_location` of a single `VisitRequest`. format double type number costPerTraveledHour description Cost per traveled hour of the vehicle route. This cost is applied only to travel time taken by the route (i.e., that reported in ShipmentRoute.transitions), and excludes waiting time and visit time. format double type number displayName description The user-defined display name of the vehicle. It can be up to 63 characters long and may use UTF-8 characters. type string endLoadIntervals deprecated True description Deprecated: Use Vehicle.LoadLimit.end_load_interval instead. items $ref GoogleCloudOptimizationV1CapacityQuantityInterval type array endLocation $ref GoogleTypeLatLng description Geographic location where the vehicle ends after it has completed its last `VisitRequest`. If not specified the vehicle's `ShipmentRoute` ends immediately when it completes its last `VisitRequest`. If the shipment model has duration and distance matrices, `end_location` must not be specified. endTags description Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed. items type string type array endTimeWindows description Time windows during which the vehicle may arrive at its end location. They must be within the global time limits (see ShipmentModel.global_* fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window. items $ref GoogleCloudOptimizationV1TimeWindow type array endWaypoint $ref GoogleCloudOptimizationV1Waypoint description Waypoint representing a geographic location where the vehicle ends after it has completed its last `VisitRequest`. If neither `end_waypoint` nor `end_location` is specified, the vehicle's `ShipmentRoute` ends immediately when it completes its last `VisitRequest`. If the shipment model has duration and distance matrices, `end_waypoint` must not be specified. extraVisitDurationForVisitType additionalProperties format google-duration type string description Specifies a map from visit_types strings to durations. The duration is time in addition to VisitRequest.duration to be taken at visits with the specified `visit_types`. This extra visit duration adds cost if `cost_per_hour` is specified. Keys (i.e. `visit_types`) cannot be empty strings. If a visit request has multiple types, a duration will be added for each type in the map. type object fixedCost description Fixed cost applied if this vehicle is used to handle a shipment. format double type number ignore description If true, `used_if_route_is_empty` must be false, and this vehicle will remain unused. If a shipment is performed by an ignored vehicle in `injected_first_solution_routes`, it is skipped in the first solution but is free to be performed in the response. If a shipment is performed by an ignored vehicle in `injected_solution_constraint` and any related pickup/delivery is constrained to remain on the vehicle (i.e., not relaxed to level `RELAX_ALL_AFTER_THRESHOLD`), it is skipped in the response. If a shipment has a non-empty `allowed_vehicle_indices` field and all of the allowed vehicles are ignored, it is skipped in the response. type boolean label description Specifies a label for this vehicle. This label is reported in the response as the `vehicle_label` of the corresponding ShipmentRoute. type string loadLimits additionalProperties $ref GoogleCloudOptimizationV1VehicleLoadLimit description Capacities of the vehicle (weight, volume, # of pallets for example). The keys in the map are the identifiers of the type of load, consistent with the keys of the Shipment.load_demands field. If a given key is absent from this map, the corresponding capacity is considered to be limitless. type object name description The resource name of the vehicle. This is a unique identifier. Format: `projects/{project}/locations/{location}/workspaces/{workspace}/vehicles/{vehicle}` This field would be ignored while calling `OptimizeTours` and `BatchOptimizeTours` methods. type string routeCommitments $ref GoogleCloudOptimizationV1RouteCommitments description The route execution state of the vehicle. This field is used in the stateful service only. routeDistanceLimit $ref GoogleCloudOptimizationV1DistanceLimit description Limit applied to the total distance of the vehicle's route. In a given `OptimizeToursResponse`, the route distance is the sum of all its transitions.travel_distance_meters. routeDurationLimit $ref GoogleCloudOptimizationV1VehicleDurationLimit description Limit applied to the total duration of the vehicle's route. In a given `OptimizeToursResponse`, the route duration of a vehicle is the difference between its `vehicle_end_time` and `vehicle_start_time`. routeModifiers $ref GoogleCloudOptimizationV1RouteModifiers description Optional. A set of conditions to satisfy that affect the way routes are calculated for the given vehicle. startLoadIntervals deprecated True description Deprecated: Use Vehicle.LoadLimit.start_load_interval instead. items $ref GoogleCloudOptimizationV1CapacityQuantityInterval type array startLocation $ref GoogleTypeLatLng description Geographic location where the vehicle starts before picking up any shipments. If not specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, `start_location` must not be specified. startTags description Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed. items type string type array startTimeWindows description Time windows during which the vehicle may depart its start location. They must be within the global time limits (see ShipmentModel.global_* fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window. items $ref GoogleCloudOptimizationV1TimeWindow type array startWaypoint $ref GoogleCloudOptimizationV1Waypoint description Waypoint representing a geographic location where the vehicle starts before picking up any shipments. If neither `start_waypoint` nor `start_location` is specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, `start_waypoint` must not be specified. travelDurationLimit $ref GoogleCloudOptimizationV1VehicleDurationLimit description Limit applied to the travel duration of the vehicle's route. In a given `OptimizeToursResponse`, the route travel duration is the sum of all its transitions.travel_duration. travelDurationMultiple description Specifies a multiplicative factor that can be used to increase or decrease travel times of this vehicle. For example, setting this to 2.0 means that this vehicle is slower and has travel times that are twice what they are for standard vehicles. This multiple does not affect visit durations. It does affect cost if `cost_per_hour` or `cost_per_traveled_hour` are specified. This must be in the range [0.001, 1000.0]. If unset, the vehicle is standard, and this multiple is considered 1.0. WARNING: Travel times will be rounded to the nearest second after this multiple is applied but before performing any numerical operations, thus, a small multiple may result in a loss of precision. See also `extra_visit_duration_for_visit_type` below. format double type number travelMode description The travel mode which affects the roads usable by the vehicle and its speed. See also `travel_duration_multiple`. enum TRAVEL_MODE_UNSPECIFIED DRIVING WALKING enumDescriptions Unspecified travel mode, equivalent to `DRIVING`. Travel mode corresponding to driving directions (car, ...). Travel mode corresponding to walking directions. type string unloadingPolicy description Unloading policy enforced on the vehicle. enum UNLOADING_POLICY_UNSPECIFIED LAST_IN_FIRST_OUT FIRST_IN_FIRST_OUT enumDescriptions Unspecified unloading policy; deliveries must just occur after their corresponding pickups. Deliveries must occur in reverse order of pickups Deliveries must occur in the same order as pickups type string usedIfRouteIsEmpty description This field only applies to vehicles when their route does not serve any shipments. It indicates if the vehicle should be considered as used or not in this case. If true, the vehicle goes from its start to its end location even if it doesn't serve any shipments, and time and distance costs resulting from its start --> end travel are taken into account. Otherwise, it doesn't travel from its start to its end location, and no `break_rule` or delay (from `TransitionAttributes`) are scheduled for this vehicle. In this case, the vehicle's `ShipmentRoute` doesn't contain any information except for the vehicle index and label. type boolean type object GoogleCloudOptimizationV1VehicleDurationLimit description A limit defining a maximum duration of the route of a vehicle. It can be either hard or soft. When a soft limit field is defined, both the soft max threshold and its associated cost must be defined together. id GoogleCloudOptimizationV1VehicleDurationLimit properties costPerHourAfterSoftMax description Cost per hour incurred if the `soft_max_duration` threshold is violated. The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows: ``` cost_per_hour_after_soft_max * (duration - soft_max_duration) ``` The cost must be nonnegative. format double type number costPerSquareHourAfterQuadraticSoftMax description Cost per square hour incurred if the `quadratic_soft_max_duration` threshold is violated. The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows: ``` cost_per_square_hour_after_quadratic_soft_max * (duration - quadratic_soft_max_duration)^2 ``` The cost must be nonnegative. format double type number maxDuration description A hard limit constraining the duration to be at most max_duration. format google-duration type string quadraticSoftMaxDuration description A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit. If defined, `quadratic_soft_max_duration` must be nonnegative. If `max_duration` is also defined, `quadratic_soft_max_duration` must be less than `max_duration`, and the difference must be no larger than one day: `max_duration - quadratic_soft_max_duration <= 86400 seconds` format google-duration type string softMaxDuration description A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit. If defined, `soft_max_duration` must be nonnegative. If max_duration is also defined, `soft_max_duration` must be less than max_duration. format google-duration type string type object GoogleCloudOptimizationV1VehicleLoadLimit description Defines a load limit applying to a vehicle, e.g. "this truck may only carry up to 3500 kg". See load_limits. id GoogleCloudOptimizationV1VehicleLoadLimit properties costPerUnitAboveSoftMax description If the load ever exceeds soft_max_load along this vehicle's route, the following cost penalty applies (only once per vehicle): (load - soft_max_load) * cost_per_unit_above_soft_max. All costs add up and must be in the same unit as Shipment.penalty_cost. format double type number endLoadInterval $ref GoogleCloudOptimizationV1VehicleLoadLimitInterval description The acceptable load interval of the vehicle at the end of the route. maxLoad description The maximum acceptable amount of load. format int64 type string softMaxLoad description A soft limit of the load. See cost_per_unit_above_soft_max. format int64 type string startLoadInterval $ref GoogleCloudOptimizationV1VehicleLoadLimitInterval description The acceptable load interval of the vehicle at the start of the route. type object GoogleCloudOptimizationV1VehicleLoadLimitInterval description Interval of acceptable load amounts. id GoogleCloudOptimizationV1VehicleLoadLimitInterval properties max description A maximum acceptable load. Must be ≥ 0. If unspecified, the maximum load is unrestricted by this message. If they're both specified, min must be ≤ max. format int64 type string min description A minimum acceptable load. Must be ≥ 0. If they're both specified, min must be ≤ max. format int64 type string type object GoogleCloudOptimizationV1Waypoint description Encapsulates a waypoint. Waypoints mark arrival and departure locations of VisitRequests, and start and end locations of Vehicles. id GoogleCloudOptimizationV1Waypoint properties location $ref GoogleCloudOptimizationV1Location description A point specified using geographic coordinates, including an optional heading. placeId description The POI Place ID associated with the waypoint. type string sideOfRoad description Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option doesn't work for the 'WALKING' travel mode. type boolean type object GoogleCloudOptimizationV1Workspace description A workspace represents a container for users to organize their resources, such as vehicles, shipments, and optimizers, etc. id GoogleCloudOptimizationV1Workspace properties displayName description The user-defined display name of the Workspace. It can be up to 63 characters long and may use UTF-8 characters. type string name description The resource name of the workspace. This is a unique identifier. Format: `projects/{project}/locations/{location}/workspaces/{workspace}` type string type object GoogleCloudOptimizationV1betaAsyncModelMetadata description The long running operation metadata for async model related methods. id GoogleCloudOptimizationV1betaAsyncModelMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the current operation. enum STATE_UNSPECIFIED RUNNING SUCCEEDED CANCELLED FAILED enumDescriptions The default value. This value is used if the state is omitted. Request is being processed. The operation completed successfully. The operation was cancelled. The operation has failed. type string stateMessage description A message providing more details about the current state of the operation. For example, the error message if the operation is failed. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudOptimizationV1betaBatchOptimizeToursResponse description Response to a `BatchOptimizeToursRequest`. This is returned in the LRO Operation after the operation is complete. id GoogleCloudOptimizationV1betaBatchOptimizeToursResponse properties type object GoogleLongrunningOperation description This resource represents a long-running operation that is the result of a network API call. id GoogleLongrunningOperation properties done description If 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. type boolean error $ref GoogleRpcStatus description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object GoogleProtobufEmpty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id GoogleProtobufEmpty properties type object GoogleRpcBadRequest description Describes violations in a client request. This error type focuses on the syntactic aspects of the request. id GoogleRpcBadRequest properties fieldViolations description Describes all violations in a client request. items $ref GoogleRpcBadRequestFieldViolation type array type object GoogleRpcBadRequestFieldViolation description A message type used to describe a single bad request field. id GoogleRpcBadRequestFieldViolation properties description description A description of why the request element is bad. type string field description A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. Consider the following: message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; } optional string email = 1; repeated EmailType type = 2; } string full_name = 1; repeated EmailAddress email_addresses = 2; } In this example, in proto `field` could take one of the following values: * `full_name` for a violation in the `full_name` value * `email_addresses[1].email` for a violation in the `email` field of the first `email_addresses` message * `email_addresses[3].type[2]` for a violation in the second `type` value in the third `email_addresses` message. In JSON, the same values are represented as: * `fullName` for a violation in the `fullName` value * `emailAddresses[1].email` for a violation in the `email` field of the first `emailAddresses` message * `emailAddresses[3].type[2]` for a violation in the second `type` value in the third `emailAddresses` message. type string localizedMessage $ref GoogleRpcLocalizedMessage description Provides a localized error message for field-level errors that is safe to return to the API consumer. reason description The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. type string type object GoogleRpcLocalizedMessage description Provides a localized error message that is safe to return to the user which can be attached to an RPC error. id GoogleRpcLocalizedMessage properties locale description The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" type string message description The localized error message in the above locale. type string type object GoogleRpcStatus description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id GoogleRpcStatus properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object GoogleTypeLatLng description An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. id GoogleTypeLatLng properties latitude description The latitude in degrees. It must be in the range [-90.0, +90.0]. format double type number longitude description The longitude in degrees. It must be in the range [-180.0, +180.0]. format double type number type object Proto2BridgeMessageSet description This is proto2's version of MessageSet. id Proto2BridgeMessageSet properties type object UtilStatusProto description Wire-format for a Status object id UtilStatusProto properties canonicalCode description The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; format int32 type integer code description Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1; format int32 type integer message description Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3; type string messageSet $ref Proto2BridgeMessageSet description message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5; space description The following are usually only present when code != 0 Space to which this status belongs copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string space = 2; type string type object servicePath title Cloud Optimization API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/cloudoptimization-v1beta	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://cloudoptimization.googleapis.com/ batchPath batch canonicalName Cloud Optimization API description Cloud Optimization API provides a portfolio of solvers to address common optimization use cases starting with optimal route planning for vehicle fleets. discoveryVersion v1 documentationLink https://cloud.google.com/optimization/docs/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id cloudoptimization:v1beta kind discovery#restDescription mtlsRootUrl https://cloudoptimization.mtls.googleapis.com/ name cloudoptimization ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects methods batchOptimizeTours description Optimizes vehicle tours for one or more `OptimizeToursRequest` messages as a batch. This method is a Long Running Operation (LRO). The inputs for optimization (`OptimizeToursRequest` messages) and outputs (`OptimizeToursResponse` messages) are read/written from/to Cloud Storage in user-specified format. Like the `OptimizeTours` method, each `OptimizeToursRequest` contains a `ShipmentModel` and returns an `OptimizeToursResponse` containing `ShipmentRoute`s, which are a set of routes to be performed by vehicles minimizing the overall cost. flatPath v1beta/projects/{projectsId}:batchOptimizeTours httpMethod POST id cloudoptimization.projects.batchOptimizeTours parameterOrder parent parameters parent description Required. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. location path pattern ^projects/[^/]+$ required True type string path v1beta/{+parent}:batchOptimizeTours request $ref GoogleCloudOptimizationV1betaBatchOptimizeToursRequest response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform optimizeTours description Sends an `OptimizeToursRequest` containing a `ShipmentModel` and returns an `OptimizeToursResponse` containing `ShipmentRoute`s, which are a set of routes to be performed by vehicles minimizing the overall cost. A `ShipmentModel` model consists mainly of `Shipment`s that need to be carried out and `Vehicles` that can be used to transport the `Shipment`s. The `ShipmentRoute`s assign `Shipment`s to `Vehicle`s. More specifically, they assign a series of `Visit`s to each vehicle, where a `Visit` corresponds to a `VisitRequest`, which is a pickup or delivery for a `Shipment`. The goal is to provide an assignment of `ShipmentRoute`s to `Vehicle`s that minimizes the total cost where cost has many components defined in the `ShipmentModel`. flatPath v1beta/projects/{projectsId}:optimizeTours httpMethod POST id cloudoptimization.projects.optimizeTours parameterOrder parent parameters parent description Required. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. location path pattern ^projects/[^/]+$ required True type string path v1beta/{+parent}:optimizeTours request $ref GoogleCloudOptimizationV1betaOptimizeToursRequest response $ref GoogleCloudOptimizationV1betaOptimizeToursResponse scopes https://www.googleapis.com/auth/cloud-platform resources locations methods batchOptimizeTours description Optimizes vehicle tours for one or more `OptimizeToursRequest` messages as a batch. This method is a Long Running Operation (LRO). The inputs for optimization (`OptimizeToursRequest` messages) and outputs (`OptimizeToursResponse` messages) are read/written from/to Cloud Storage in user-specified format. Like the `OptimizeTours` method, each `OptimizeToursRequest` contains a `ShipmentModel` and returns an `OptimizeToursResponse` containing `ShipmentRoute`s, which are a set of routes to be performed by vehicles minimizing the overall cost. flatPath v1beta/projects/{projectsId}/locations/{locationsId}:batchOptimizeTours httpMethod POST id cloudoptimization.projects.locations.batchOptimizeTours parameterOrder parent parameters parent description Required. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1beta/{+parent}:batchOptimizeTours request $ref GoogleCloudOptimizationV1betaBatchOptimizeToursRequest response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform optimizeTours description Sends an `OptimizeToursRequest` containing a `ShipmentModel` and returns an `OptimizeToursResponse` containing `ShipmentRoute`s, which are a set of routes to be performed by vehicles minimizing the overall cost. A `ShipmentModel` model consists mainly of `Shipment`s that need to be carried out and `Vehicles` that can be used to transport the `Shipment`s. The `ShipmentRoute`s assign `Shipment`s to `Vehicle`s. More specifically, they assign a series of `Visit`s to each vehicle, where a `Visit` corresponds to a `VisitRequest`, which is a pickup or delivery for a `Shipment`. The goal is to provide an assignment of `ShipmentRoute`s to `Vehicle`s that minimizes the total cost where cost has many components defined in the `ShipmentModel`. flatPath v1beta/projects/{projectsId}/locations/{locationsId}:optimizeTours httpMethod POST id cloudoptimization.projects.locations.optimizeTours parameterOrder parent parameters parent description Required. Target project and location to make a call. Format: `projects/{project-id}/locations/{location-id}`. If no location is specified, a region will be chosen automatically. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1beta/{+parent}:optimizeTours request $ref GoogleCloudOptimizationV1betaOptimizeToursRequest response $ref GoogleCloudOptimizationV1betaOptimizeToursResponse scopes https://www.googleapis.com/auth/cloud-platform resources operations methods get description Gets 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. flatPath v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id cloudoptimization.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1beta/{+name} response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform operations methods get description Gets 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. flatPath v1beta/projects/{projectsId}/operations/{operationsId} httpMethod GET id cloudoptimization.projects.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/operations/[^/]+$ required True type string path v1beta/{+name} response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform revision 20250117 rootUrl https://cloudoptimization.googleapis.com/ schemas GoogleCloudOptimizationV1AsyncModelMetadata description The long running operation metadata for async model related methods. id GoogleCloudOptimizationV1AsyncModelMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the current operation. enum STATE_UNSPECIFIED RUNNING SUCCEEDED CANCELLED FAILED enumDescriptions The default value. This value is used if the state is omitted. Request is being processed. The operation completed successfully. The operation was cancelled. The operation has failed. type string stateMessage description A message providing more details about the current state of the operation. For example, the error message if the operation is failed. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudOptimizationV1BatchOptimizeToursResponse description Response to a `BatchOptimizeToursRequest`. This is returned in the LRO Operation after the operation is complete. id GoogleCloudOptimizationV1BatchOptimizeToursResponse properties type object GoogleCloudOptimizationV1RunOptimizerMetadata description The long running operation metadata for `RunOptimizer` method. id GoogleCloudOptimizationV1RunOptimizerMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the current operation. enum STATE_UNSPECIFIED RUNNING SUCCEEDED FAILED enumDescriptions The default value. This value is used if the state is omitted. Request is being processed. The operation succeeded. The operation failed. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudOptimizationV1RunOptimizerResponse description The response message for `RunOptimizer` method. id GoogleCloudOptimizationV1RunOptimizerResponse properties solution description The name of the solution for this optimization. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/solutions/{solution}" type string type object GoogleCloudOptimizationV1betaAsyncModelMetadata description The long running operation metadata for async model related methods. id GoogleCloudOptimizationV1betaAsyncModelMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the current operation. enum STATE_UNSPECIFIED RUNNING SUCCEEDED CANCELLED FAILED enumDescriptions The default value. This value is used if the state is omitted. Request is being processed. The operation completed successfully. The operation was cancelled. The operation has failed. type string stateMessage description A message providing more details about the current state of the operation. For example, the error message if the operation is failed. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudOptimizationV1betaBatchOptimizeToursRequest description Request to batch optimize tours as an asynchronous operation. Each input file should contain one `OptimizeToursRequest`, and each output file will contain one `OptimizeToursResponse`. The request contains information to read/write and parse the files. All the input and output files should be under the same project. id GoogleCloudOptimizationV1betaBatchOptimizeToursRequest properties modelConfigs description Required. Input/Output information each purchase model, such as file paths and data formats. items $ref GoogleCloudOptimizationV1betaBatchOptimizeToursRequestAsyncModelConfig type array type object GoogleCloudOptimizationV1betaBatchOptimizeToursRequestAsyncModelConfig description Information for solving one optimization model asynchronously. id GoogleCloudOptimizationV1betaBatchOptimizeToursRequestAsyncModelConfig properties displayName description User defined model name, can be used as alias by users to keep track of models. type string inputConfig $ref GoogleCloudOptimizationV1betaInputConfig description Required. Information about the input model. outputConfig $ref GoogleCloudOptimizationV1betaOutputConfig description Required. The desired output location information. type object GoogleCloudOptimizationV1betaBatchOptimizeToursResponse description Response to a `BatchOptimizeToursRequest`. This is returned in the LRO Operation after the operation is complete. id GoogleCloudOptimizationV1betaBatchOptimizeToursResponse properties type object GoogleCloudOptimizationV1betaCapacityQuantity description Any nonnegative additive quantity with an integer amount that can be used to represent capacity of a `Vehicle` and consumption of that capacity by a Shipment. Example: `type: "weight_grams" value: 450000` `type: "volume_liters" value: 10000` id GoogleCloudOptimizationV1betaCapacityQuantity properties type description A unique identifier of the type of this quantity, used to match several `CapacityQuantity` in different contexts. It should be self-descriptive, including the units used; see the examples in message comment. type string value description The quantity itself. Since it is an integer (whose precision may impact performance), clients are advised to choose an appropriate unit. It must be nonnegative, but we use int64 because it's more compact on the wire. format int64 type string type object GoogleCloudOptimizationV1betaCapacityQuantityInterval description An interval of values a capacity quantity can have. See CapacityQuantity above. id GoogleCloudOptimizationV1betaCapacityQuantityInterval properties maxValue description The maximum value the capacity quantity can have. It must be nonnegative. If left unspecified, the maximum quantity is unrestricted by this bound, but may be restricted by other constraints. At least one of `min_value` and `max_value` must be set. format int64 type string minValue description The minimum value the capacity quantity can have. It must be nonnegative. If left unspecified, the minimum quantity is unrestricted by this bound, but may be restricted by other constraints. At least one of `min_value` and `max_value` must be set. format int64 type string type description A unique identifier of the type of this quantity. type string type object GoogleCloudOptimizationV1betaDistanceLimit description A limit defining a maximum distance which can be traveled. It can be either hard or soft. If a soft limit is defined, both `soft_max_meters` and `cost_per_kilometer_above_soft_max` must be defined and be nonnegative. id GoogleCloudOptimizationV1betaDistanceLimit properties costPerKilometerAboveSoftMax description Cost per kilometer incurred if `soft_max_meters` limit is violated. The additional cost is 0 if the distance is under the limit, otherwise the formula used to compute the cost is the following: ``` (distance_meters - soft_max_meters) / 1000.0 * cost_per_kilometer_above_soft_max. ``` The cost must be nonnegative. format double type number maxMeters description A hard limit constraining the distance to be at most max_meters. The limit must be nonnegative. format int64 type string softMaxMeters description A soft limit not enforcing a maximum distance limit, but when violated results in a cost which adds up to other costs defined in the model, with the same unit. If defined soft_max_meters must be less than max_meters and must be nonnegative. format int64 type string type object GoogleCloudOptimizationV1betaGcsDestination description The Google Cloud Storage location where the output file will be written to. id GoogleCloudOptimizationV1betaGcsDestination properties uri description Required. URI of the Google Cloud Storage location. type string type object GoogleCloudOptimizationV1betaGcsSource description The Google Cloud Storage location where the input file will be read from. id GoogleCloudOptimizationV1betaGcsSource properties uri description Required. URI of the Google Cloud Storage location. type string type object GoogleCloudOptimizationV1betaInjectedSolutionConstraint description Solution injected in the request including information about which visits must be constrained and how they must be constrained. id GoogleCloudOptimizationV1betaInjectedSolutionConstraint properties constraintRelaxations description For zero or more groups of vehicles, specifies when and how much to relax constraints. If this field is empty, all non-empty vehicle routes are fully constrained. items $ref GoogleCloudOptimizationV1betaInjectedSolutionConstraintConstraintRelaxation type array routes description Routes of the solution to inject. Some routes may be omitted from the original solution. The routes and skipped shipments must satisfy the basic validity assumptions listed for `injected_first_solution_routes`. items $ref GoogleCloudOptimizationV1betaShipmentRoute type array skippedShipments description Skipped shipments of the solution to inject. Some may be omitted from the original solution. See the `routes` field. items $ref GoogleCloudOptimizationV1betaSkippedShipment type array type object GoogleCloudOptimizationV1betaInjectedSolutionConstraintConstraintRelaxation description For a group of vehicles, specifies at what threshold(s) constraints on visits will be relaxed and to which level. Shipments listed in the `skipped_shipment` field are constrained to be skipped; i.e., they cannot be performed. id GoogleCloudOptimizationV1betaInjectedSolutionConstraintConstraintRelaxation properties relaxations description All the visit constraint relaxations that will apply to visits on routes with vehicles in `vehicle_indices`. items $ref GoogleCloudOptimizationV1betaInjectedSolutionConstraintConstraintRelaxationRelaxation type array vehicleIndices description Specifies the vehicle indices to which the visit constraint `relaxations` apply. If empty, this is considered the default and the `relaxations` apply to all vehicles that are not specified in other `constraint_relaxations`. There can be at most one default, i.e., at most one constraint relaxation field is allowed empty `vehicle_indices`. A vehicle index can only be listed once, even within several `constraint_relaxations`. A vehicle index is mapped the same as ShipmentRoute.vehicle_index, if `interpret_injected_solutions_using_labels` is true (see `fields` comment). items format int32 type integer type array type object GoogleCloudOptimizationV1betaInjectedSolutionConstraintConstraintRelaxationRelaxation description If `relaxations` is empty, the start time and sequence of all visits on `routes` are fully constrained and no new visits may be inserted or added to those routes. Also, a vehicle's start and end time in `routes` is fully constrained, unless the vehicle is empty (i.e., has no visits and has `used_if_route_is_empty` set to false in the model). `relaxations(i).level` specifies the constraint relaxation level applied to a visit #j that satisfies: * `route.visits(j).start_time >= relaxations(i).threshold_time` AND * `j + 1 >= relaxations(i).threshold_visit_count` Similarly, the vehicle start is relaxed to `relaxations(i).level` if it satisfies: * `vehicle_start_time >= relaxations(i).threshold_time` AND * `relaxations(i).threshold_visit_count == 0` and the vehicle end is relaxed to `relaxations(i).level` if it satisfies: * `vehicle_end_time >= relaxations(i).threshold_time` AND * `route.visits_size() + 1 >= relaxations(i).threshold_visit_count` To apply a relaxation level if a visit meets the `threshold_visit_count` OR the `threshold_time` add two `relaxations` with the same `level`: one with only `threshold_visit_count` set and the other with only `threshold_time` set. If a visit satisfies the conditions of multiple `relaxations`, the most relaxed level applies. As a result, from the vehicle start through the route visits in order to the vehicle end, the relaxation level becomes more relaxed: i.e., the relaxation level is non-decreasing as the route progresses. The timing and sequence of route visits that do not satisfy the threshold conditions of any `relaxations` are fully constrained and no visits may be inserted into these sequences. Also, if a vehicle start or end does not satisfy the conditions of any relaxation the time is fixed, unless the vehicle is empty. id GoogleCloudOptimizationV1betaInjectedSolutionConstraintConstraintRelaxationRelaxation properties level description The constraint relaxation level that applies when the conditions at or after `threshold_time` AND at least `threshold_visit_count` are satisfied. enum LEVEL_UNSPECIFIED RELAX_VISIT_TIMES_AFTER_THRESHOLD RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD RELAX_ALL_AFTER_THRESHOLD enumDescriptions Implicit default relaxation level: no constraints are relaxed, i.e., all visits are fully constrained. This value must not be explicitly used in `level`. Visit start times and vehicle start/end times will be relaxed, but each visit remains bound to the same vehicle and the visit sequence must be observed: no visit can be inserted between them or before them. Same as `RELAX_VISIT_TIMES_AFTER_THRESHOLD`, but the visit sequence is also relaxed: visits can only be performed by this vehicle, but can potentially become unperformed. Same as `RELAX_VISIT_TIMES_AND_SEQUENCE_AFTER_THRESHOLD`, but the vehicle is also relaxed: visits are completely free at or after the threshold time and can potentially become unperformed. type string thresholdTime description The time at or after which the relaxation `level` may be applied. format google-datetime type string thresholdVisitCount description The number of visits at or after which the relaxation `level` may be applied. If `threshold_visit_count` is 0 (or unset), the `level` may be applied directly at the vehicle start. If it is `route.visits_size() + 1`, the `level` may only be applied to the vehicle end. If it is more than `route.visits_size() + 1`, `level` is not applied at all for that route. format int32 type integer type object GoogleCloudOptimizationV1betaInputConfig description The desired input location information. id GoogleCloudOptimizationV1betaInputConfig properties dataFormat description The input data format that used to store the model in Cloud Storage. enum DATA_FORMAT_UNSPECIFIED JSON STRING enumDescriptions Default value. Input data in json format. Input data in string format. type string gcsSource $ref GoogleCloudOptimizationV1betaGcsSource description The Google Cloud Storage location to read the input from. This must be a single file. type object GoogleCloudOptimizationV1betaOptimizeToursRequest description Request to be given to a tour optimization solver which defines the shipment model to solve as well as optimization parameters. id GoogleCloudOptimizationV1betaOptimizeToursRequest properties allowLargeDeadlineDespiteInterruptionRisk description If this is set, then the request can have a deadline (see https://grpc.io/blog/deadlines) of up to 60 minutes. Otherwise, the maximum deadline is only 30 minutes. Note that long-lived requests have a significantly larger (but still small) risk of interruption. type boolean considerRoadTraffic description Consider traffic estimation in calculating `ShipmentRoute` fields Transition.travel_duration, Visit.start_time, and `vehicle_end_time`; in setting the ShipmentRoute.has_traffic_infeasibilities field, and in calculating the OptimizeToursResponse.total_cost field. type boolean geodesicMetersPerSecond description When `use_geodesic_distances` is true, this field must be set and defines the speed applied to compute travel times. Its value must be at least 1.0 meters/seconds. format double type number googleMapsApiKey description Cloud Fleet Routing service provides an optional integration with the routing services offered by Google Maps Platform. This is for the cases where the callers can't provide their own pre-computed distance matrices directly in `ShipmentModel`s. The key is used to invoke the API(s) on the caller's behalf, when the service needs to compute travel times and distances or polylines between between the geolocations present in the request. The callers are responsible for enabling the API(s) and accepting Google Maps terms of service. type string injectedFirstSolutionRoutes description Guide the optimization algorithm in finding a first solution that is similar to a previous solution. The model is constrained when the first solution is built. Any shipments not performed on a route are implicitly skipped in the first solution, but they may be performed in successive solutions. The solution must satisfy some basic validity assumptions: * for all routes, `vehicle_index` must be in range and not be duplicated. * for all visits, `shipment_index` and `visit_request_index` must be in range. * a shipment may only be referenced on one route. * the pickup of a pickup-delivery shipment must be performed before the delivery. * no more than one pickup alternative or delivery alternative of a shipment may be performed. * for all routes, times are increasing (i.e., `vehicle_start_time <= visits[0].start_time <= visits[1].start_time ... <= vehicle_end_time`). * a shipment may only be performed on a vehicle that is allowed. A vehicle is allowed if Shipment.allowed_vehicle_indices is empty or its `vehicle_index` is included in Shipment.allowed_vehicle_indices. If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead. items $ref GoogleCloudOptimizationV1betaShipmentRoute type array injectedSolutionConstraint $ref GoogleCloudOptimizationV1betaInjectedSolutionConstraint description Constrain the optimization algorithm to find a final solution that is similar to a previous solution. For example, this may be used to freeze portions of routes which have already been completed or which are to be completed but must not be modified. If the injected solution is not feasible, a validation error is not necessarily returned and an error indicating infeasibility may be returned instead. interpretInjectedSolutionsUsingLabels description If true: * uses ShipmentRoute.vehicle_label instead of `vehicle_index` to match routes in an injected solution with vehicles in the request; reuses the mapping of original ShipmentRoute.vehicle_index to new ShipmentRoute.vehicle_index to update ConstraintRelaxation.vehicle_indices if non-empty, but the mapping must be unambiguous (i.e., multiple `ShipmentRoute`s must not share the same original `vehicle_index`). * uses ShipmentRoute.Visit.shipment_label instead of `shipment_index` to match visits in an injected solution with shipments in the request; * uses SkippedShipment.label instead of SkippedShipment.index to match skipped shipments in the injected solution with request shipments. This interpretation applies to the `injected_first_solution_routes`, `injected_solution_constraint`, and `refresh_details_routes` fields. It can be used when shipment or vehicle indices in the request have changed since the solution was created, perhaps because shipments or vehicles have been removed from or added to the request. If true, labels in the following categories must appear at most once in their category: * Vehicle.label in the request; * Shipment.label in the request; * ShipmentRoute.vehicle_label in the injected solution; * SkippedShipment.label and ShipmentRoute.Visit.shipment_label in the injected solution (except pickup/delivery visit pairs, whose `shipment_label` must appear twice). If a `vehicle_label` in the injected solution does not correspond to a request vehicle, the corresponding route is removed from the solution along with its visits. If a `shipment_label` in the injected solution does not correspond to a request shipment, the corresponding visit is removed from the solution. If a SkippedShipment.label in the injected solution does not correspond to a request shipment, the `SkippedShipment` is removed from the solution. Removing route visits or entire routes from an injected solution may have an effect on the implied constraints, which may lead to change in solution, validation errors, or infeasibility. NOTE: The caller must ensure that each Vehicle.label (resp. Shipment.label) uniquely identifies a vehicle (resp. shipment) entity used across the two relevant requests: the past request that produced the `OptimizeToursResponse` used in the injected solution and the current request that includes the injected solution. The uniqueness checks described above are not enough to guarantee this requirement. type boolean label description Label that may be used to identify this request, reported back in the OptimizeToursResponse.request_label. type string maxValidationErrors description If `solving_mode` is `VALIDATE_ONLY`, this controls the maximum number of validation errors we return. This defaults to 100 and is capped at 10,000. format int32 type integer model $ref GoogleCloudOptimizationV1betaShipmentModel description Shipment model to solve. populatePolylines description If true, polylines will be populated in response `ShipmentRoute`s. type boolean populateTransitionPolylines description If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated `travel_steps`. type boolean populateTravelStepPolylines deprecated True description **DEPRECATED** If true, polylines will be populated in response ShipmentRoute.transitions. Note that in this case, the polylines will also be populated in the deprecated `travel_steps`. type boolean refreshDetailsRoutes description If non-empty, the given routes will be refreshed, without modifying their underlying sequence of visits or travel times: only other details will be updated. This does not solve the model. As of 2020/11, this only populates the polylines of non-empty routes and requires that `populate_polylines` is true. The `route_polyline` fields of the passed-in routes may be inconsistent with route `transitions`. This field must not be used together with `injected_first_solution_routes` or `injected_solution_constraint`. `Shipment.ignore` and `Vehicle.ignore` have no effect on the behavior. Polylines are still populated between all visits in all non-empty routes regardless of whether the related shipments or vehicles are ignored. items $ref GoogleCloudOptimizationV1betaShipmentRoute type array searchMode description Search mode used to solve the request. enum SEARCH_MODE_UNSPECIFIED RETURN_FAST CONSUME_ALL_AVAILABLE_TIME enumDescriptions Unspecified search mode, equivalent to `RETURN_FAST`. Stop the search after finding the first good solution. Spend all the available time to search for better solutions. type string solvingMode description By default, the solving mode is `DEFAULT_SOLVE` (0). enum DEFAULT_SOLVE VALIDATE_ONLY DETECT_SOME_INFEASIBLE_SHIPMENTS enumDescriptions Solve the model. Warnings may be issued in OptimizeToursResponse.validation_errors. Only validates the model without solving it: populates as many OptimizeToursResponse.validation_errors as possible. Only populates OptimizeToursResponse.validation_errors or OptimizeToursResponse.skipped_shipments, and doesn't actually solve the rest of the request (`status` and `routes` are unset in the response). If infeasibilities in `injected_solution_constraint` routes are detected they are populated in the OptimizeToursResponse.validation_errors field and OptimizeToursResponse.skipped_shipments is left empty. *IMPORTANT*: not all infeasible shipments are returned here, but only the ones that are detected as infeasible during preprocessing. type string timeout description If this timeout is set, the server returns a response before the timeout period has elapsed or the server deadline for synchronous requests is reached, whichever is sooner. For asynchronous requests, the server will generate a solution (if possible) before the timeout has elapsed. format google-duration type string useGeodesicDistances description If true, travel distances will be computed using geodesic distances instead of Google Maps distances, and travel times will be computed using geodesic distances with a speed defined by `geodesic_meters_per_second`. type boolean type object GoogleCloudOptimizationV1betaOptimizeToursResponse description Response after solving a tour optimization problem containing the routes followed by each vehicle, the shipments which have been skipped and the overall cost of the solution. id GoogleCloudOptimizationV1betaOptimizeToursResponse properties requestLabel description Copy of the OptimizeToursRequest.label, if a label was specified in the request. type string routes description Routes computed for each vehicle; the i-th route corresponds to the i-th vehicle in the model. items $ref GoogleCloudOptimizationV1betaShipmentRoute type array skippedShipments description The list of all shipments skipped. items $ref GoogleCloudOptimizationV1betaSkippedShipment type array totalCost description Total cost of the solution. This takes into account all costs: costs per per hour and travel hour, fixed vehicle costs, unperformed shipment penalty costs, global duration cost, etc. format double type number validationErrors description List of all the validation errors that we were able to detect independently. See the "MULTIPLE ERRORS" explanation for the OptimizeToursValidationError message. Instead of errors, this will include warnings in the case `solving_mode` is `DEFAULT_SOLVE`. items $ref GoogleCloudOptimizationV1betaOptimizeToursValidationError type array type object GoogleCloudOptimizationV1betaOptimizeToursValidationError description Describes an error or warning encountered when validating an `OptimizeToursRequest`. id GoogleCloudOptimizationV1betaOptimizeToursValidationError properties code description A validation error is defined by the pair (`code`, `display_name`) which are always present. Other fields (below) provide more context about the error. *MULTIPLE ERRORS*: When there are multiple errors, the validation process tries to output several of them. Much like a compiler, this is an imperfect process. Some validation errors will be "fatal", meaning that they stop the entire validation process. This is the case for `display_name="UNSPECIFIED"` errors, among others. Some may cause the validation process to skip other errors. *STABILITY*: `code` and `display_name` should be very stable. But new codes and display names may appear over time, which may cause a given (invalid) request to yield a different (`code`, `display_name`) pair because the new error hid the old one (see "MULTIPLE ERRORS"). format int32 type integer displayName description The error display name. type string errorMessage description Human-readable string describing the error. There is a 1:1 mapping between `code` and `error_message` (when code != "UNSPECIFIED"). *STABILITY*: Not stable: the error message associated to a given `code` may change (hopefully to clarify it) over time. Please rely on the `display_name` and `code` instead. type string fields description An error context may involve 0, 1 (most of the time) or more fields. For example, referring to vehicle #4 and shipment #2's first pickup can be done as follows: ``` fields { name: "vehicles" index: 4} fields { name: "shipments" index: 2 sub_field {name: "pickups" index: 0} } ``` Note, however, that the cardinality of `fields` should not change for a given error code. items $ref GoogleCloudOptimizationV1betaOptimizeToursValidationErrorFieldReference type array offendingValues description May contain the value(s) of the field(s). This is not always available. You should absolutely not rely on it and use it only for manual model debugging. type string type object GoogleCloudOptimizationV1betaOptimizeToursValidationErrorFieldReference description Specifies a context for the validation error. A `FieldReference` always refers to a given field in this file and follows the same hierarchical structure. For example, we may specify element #2 of `start_time_windows` of vehicle #5 using: ``` name: "vehicles" index: 5 sub_field { name: "end_time_windows" index: 2 } ``` We however omit top-level entities such as `OptimizeToursRequest` or `ShipmentModel` to avoid crowding the message. id GoogleCloudOptimizationV1betaOptimizeToursValidationErrorFieldReference properties index description Index of the field if repeated. format int32 type integer name description Name of the field, e.g., "vehicles". type string subField $ref GoogleCloudOptimizationV1betaOptimizeToursValidationErrorFieldReference description Recursively nested sub-field, if needed. type object GoogleCloudOptimizationV1betaOutputConfig description The desired output location. id GoogleCloudOptimizationV1betaOutputConfig properties dataFormat description The output data format that used to store the results in Cloud Storage. enum DATA_FORMAT_UNSPECIFIED JSON STRING enumDescriptions Default value. Input data in json format. Input data in string format. type string gcsDestination $ref GoogleCloudOptimizationV1betaGcsDestination description The Google Cloud Storage location to write the output to. type object GoogleCloudOptimizationV1betaShipment description The shipment of a single item, from one of its pickups to one of its deliveries. For the shipment to be considered as performed, a unique vehicle must visit one of its pickup locations (and decrease its spare capacities accordingly), then visit one of its delivery locations later on (and therefore re-increase its spare capacities accordingly). id GoogleCloudOptimizationV1betaShipment properties allowedVehicleIndices description The set of vehicles that may perform this shipment. If empty, all vehicles may perform it. Vehicles are given by their index in the `ShipmentModel`'s `vehicles` list. items format int32 type integer type array costsPerVehicle description Specifies the cost that is incurred when this shipment is delivered by each vehicle. If specified, it must have EITHER: * the same number of elements as `costs_per_vehicle_indices`. `costs_per_vehicle[i]` corresponds to vehicle `costs_per_vehicle_indices[i]` of the model. * the same number of elements as there are vehicles in the model. The i-th element corresponds to vehicle #i of the model. These costs must be in the same unit as `penalty_cost` and must not be negative. Leave this field empty, if there are no such costs. items format double type number type array costsPerVehicleIndices description Indices of the vehicles to which `costs_per_vehicle` applies. If non-empty, it must have the same number of elements as `costs_per_vehicle`. A vehicle index may not be specified more than once. If a vehicle is excluded from `costs_per_vehicle_indices`, its cost is zero. items format int32 type integer type array deliveries description Set of delivery alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the pickups. items $ref GoogleCloudOptimizationV1betaShipmentVisitRequest type array demands description Demand of the shipment, broken up in several `CapacityQuantity` messages, one for each quantity type. The corresponding quantities will be subtracted from the vehicle capacity after performing a pickup or added to the capacity after a delivery (see Vehicle.capacities). In particular, this means that the `CapacityQuantity` used in different shipments and in the vehicle capacities must all be compatible. If a demand is not specified for a given type it will be considered as null. `CapacityQuantity` types in this field must be unique. items $ref GoogleCloudOptimizationV1betaCapacityQuantity type array ignore description If true, skip this shipment, but don't apply a `penalty_cost`. Ignoring a shipment results in a validation error when there are any `shipment_type_requirements` in the model. Ignoring a shipment that is performed in `injected_first_solution_routes` or `injected_solution_constraint` is permitted; the solver removes the related pickup/delivery visits from the performing route. `precedence_rules` that reference ignored shipments will also be ignored. type boolean label description Specifies a label for this shipment. This label is reported in the response in the `shipment_label` of the corresponding ShipmentRoute.Visit. type string penaltyCost description If the shipment is not completed, this penalty is added to the overall cost of the routes. A shipment is considered completed if one of its pickup and delivery alternatives is visited. The cost may be expressed in the same unit used for all other cost-related fields in the model and must be positive. *IMPORTANT*: If this penalty is not specified, it is considered infinite, i.e. the shipment must be completed. format double type number pickupToDeliveryAbsoluteDetourLimit description Specifies the maximum absolute detour time compared to the shortest path from pickup to delivery. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery. For example, let t be the shortest time taken to go from the selected pickup alternative directly to the selected delivery alternative. Then setting `pickup_to_delivery_absolute_detour_limit` enforces: ``` start_time(delivery) - start_time(pickup) <= t + pickup_to_delivery_absolute_detour_limit ``` If both relative and absolute limits are specified on the same shipment, the more constraining limit is used for each possible pickup/delivery pair. As of 10/2017, detours are only supported when travel durations do not depend on vehicles. format google-duration type string pickupToDeliveryRelativeDetourLimit description Specifies the maximum relative detour time compared to the shortest path from pickup to delivery. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery. For example, let t be the shortest time taken to go from the selected pickup alternative directly to the selected delivery alternative. Then setting `pickup_to_delivery_relative_detour_limit` enforces: ``` start_time(delivery) - start_time(pickup) <= std::ceil(t * (1.0 + pickup_to_delivery_relative_detour_limit)) ``` If both relative and absolute limits are specified on the same shipment, the more constraining limit is used for each possible pickup/delivery pair. As of 10/2017, detours are only supported when travel durations do not depend on vehicles. format double type number pickupToDeliveryTimeLimit description Specifies the maximum duration from start of pickup to start of delivery of a shipment. If specified, it must be nonnegative, and the shipment must contain at least a pickup and a delivery. This does not depend on which alternatives are selected for pickup and delivery, nor on vehicle speed. This can be specified alongside maximum detour constraints: the solution will respect both specifications. format google-duration type string pickups description Set of pickup alternatives associated to the shipment. If not specified, the vehicle only needs to visit a location corresponding to the deliveries. items $ref GoogleCloudOptimizationV1betaShipmentVisitRequest type array shipmentType description Non-empty string specifying a "type" for this shipment. This feature can be used to define incompatibilities or requirements between `shipment_types` (see `shipment_type_incompatibilities` and `shipment_type_requirements` in `ShipmentModel`). Differs from `visit_types` which is specified for a single visit: All pickup/deliveries belonging to the same shipment share the same `shipment_type`. type string type object GoogleCloudOptimizationV1betaShipmentModel description A shipment model contains a set of shipments which must be performed by a set of vehicles, while minimizing the overall cost, which is the sum of: * the cost of routing the vehicles (sum of cost per total time, cost per travel time, and fixed cost over all vehicles). * the unperformed shipment penalties. * the cost of the global duration of the shipments id GoogleCloudOptimizationV1betaShipmentModel properties breakRules description Set of break rules used in the model. Each vehicle specifies the `BreakRule` that applies to it via the Vehicle.break_rule_indices field (which must be a singleton). items $ref GoogleCloudOptimizationV1betaShipmentModelBreakRule type array durationDistanceMatrices description Specifies duration and distance matrices used in the model. If this field is empty, Google Maps or geodesic distances will be used instead, depending on the value of the `use_geodesic_distances` field. If it is not empty, `use_geodesic_distances` cannot be true and neither `duration_distance_matrix_src_tags` nor `duration_distance_matrix_dst_tags` can be empty. Usage examples: * There are two locations: locA and locB. * 1 vehicle starting its route at locA and ending it at locA. * 1 pickup visit request at locB. ``` model { vehicles { start_tags: "locA" end_tags: "locA" } shipments { pickups { tags: "locB" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_dst_tags: "locA" duration_distance_matrix_dst_tags: "locB" duration_distance_matrices { rows { # from: locA durations { seconds: 0 } meters: 0 # to: locA durations { seconds: 100 } meters: 1000 # to: locB } rows { # from: locB durations { seconds: 102 } meters: 990 # to: locA durations { seconds: 0 } meters: 0 # to: locB } } } ``` * There are three locations: locA, locB and locC. * 1 vehicle starting its route at locA and ending it at locB, using matrix "fast". * 1 vehicle starting its route at locB and ending it at locB, using matrix "slow". * 1 vehicle starting its route at locB and ending it at locB, using matrix "fast". * 1 pickup visit request at locC. ``` model { vehicles { start_tags: "locA" end_tags: "locB" start_tags: "fast" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "slow" } vehicles { start_tags: "locB" end_tags: "locB" start_tags: "fast" } shipments { pickups { tags: "locC" } } duration_distance_matrix_src_tags: "locA" duration_distance_matrix_src_tags: "locB" duration_distance_matrix_src_tags: "locC" duration_distance_matrix_dst_tags: "locB" duration_distance_matrix_dst_tags: "locC" duration_distance_matrices { vehicle_start_tag: "fast" rows { # from: locA durations { seconds: 1000 } meters: 2000 # to: locB durations { seconds: 600 } meters: 1000 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 700 } meters: 1200 # to: locC } rows { # from: locC durations { seconds: 702 } meters: 1190 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } duration_distance_matrices { vehicle_start_tag: "slow" rows { # from: locA durations { seconds: 1800 } meters: 2001 # to: locB durations { seconds: 900 } meters: 1002 # to: locC } rows { # from: locB durations { seconds: 0 } meters: 0 # to: locB durations { seconds: 1000 } meters: 1202 # to: locC } rows { # from: locC durations { seconds: 1001 } meters: 1195 # to: locB durations { seconds: 0 } meters: 0 # to: locC } } } ``` items $ref GoogleCloudOptimizationV1betaShipmentModelDurationDistanceMatrix type array durationDistanceMatrixDstTags description Tags defining the destinations of the duration and distance matrices; `duration_distance_matrices(i).rows(j).durations(k)` (resp. `duration_distance_matrices(i).rows(j).meters(k))` defines the duration (resp. the distance) of the travel from visits with tag `duration_distance_matrix_src_tags(j)` to visits with tag `duration_distance_matrix_dst_tags(k)` in matrix i. Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given `VisitRequest` or `Vehicle` must match exactly one tag in this field. Note that a `Vehicle`'s source, destination and matrix tags may be the same; similarly a `VisitRequest`'s source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then `duration_distance_matrices` must not be empty. items type string type array durationDistanceMatrixSrcTags description Tags defining the sources of the duration and distance matrices; `duration_distance_matrices(i).rows(j)` defines durations and distances from visits with tag `duration_distance_matrix_src_tags(j)` to other visits in matrix i. Tags correspond to VisitRequest.tags or Vehicle.start_tags. A given `VisitRequest` or `Vehicle` must match exactly one tag in this field. Note that a `Vehicle`'s source, destination and matrix tags may be the same; similarly a `VisitRequest`'s source and destination tags may be the same. All tags must be different and cannot be empty strings. If this field is not empty, then `duration_distance_matrices` must not be empty. items type string type array globalDurationCostPerHour description The "global duration" of the overall plan is the difference between the earliest effective start time and the latest effective end time of all vehicles. Users can assign a cost per hour to that quantity to try and optimize for earliest job completion, for example. This cost must be in the same unit as Shipment.penalty_cost. format double type number globalEndTime description If unset, 00:00:00 UTC, January 1, 1971 (i.e. seconds: 31536000, nanos: 0) is used as default. format google-datetime type string globalStartTime description Global start and end time of the model: no times outside of this range can be considered valid. The model's time span must be less than a year, i.e. the `global_end_time` and the `global_start_time` must be within 31536000 seconds of each other. When using `cost_per_*hour` fields, you might want to set this window to a smaller interval to increase performance (eg. if you model a single day, you should set the global time limits to that day). If unset, 00:00:00 UTC, January 1, 1970 (i.e. seconds: 0, nanos: 0) is used as default. format google-datetime type string maxActiveVehicles description Constrains the maximum number of active vehicles. A vehicle is active if its route performs at least one shipment. This can be used to limit the number of routes in the case where there are fewer drivers than vehicles and that the fleet of vehicles is heterogeneous. The optimization will then select the best subset of vehicles to use. Must be strictly positive. format int32 type integer precedenceRules description Set of precedence rules which must be enforced in the model. items $ref GoogleCloudOptimizationV1betaShipmentModelPrecedenceRule type array shipmentTypeIncompatibilities description Sets of incompatible shipment_types (see `ShipmentTypeIncompatibility`). items $ref GoogleCloudOptimizationV1betaShipmentTypeIncompatibility type array shipmentTypeRequirements description Sets of `shipment_type` requirements (see `ShipmentTypeRequirement`). items $ref GoogleCloudOptimizationV1betaShipmentTypeRequirement type array shipments description Set of shipments which must be performed in the model. items $ref GoogleCloudOptimizationV1betaShipment type array transitionAttributes description Transition attributes added to the model. items $ref GoogleCloudOptimizationV1betaTransitionAttributes type array vehicles description Set of vehicles which can be used to perform visits. items $ref GoogleCloudOptimizationV1betaVehicle type array type object GoogleCloudOptimizationV1betaShipmentModelBreakRule description Rules to generate time breaks for a vehicle (e.g. lunch breaks). A break is a contiguous period of time during which the vehicle remains idle at its current position and cannot perform any visit. A break may occur: * during the travel between two visits (which includes the time right before or right after a visit, but not in the middle of a visit), in which case it extends the corresponding transit time between the visits, * or before the vehicle start (the vehicle may not start in the middle of a break), in which case it does not affect the vehicle start time. * or after the vehicle end (ditto, with the vehicle end time). id GoogleCloudOptimizationV1betaShipmentModelBreakRule properties breakRequests description Sequence of breaks. See the `BreakRequest` message. items $ref GoogleCloudOptimizationV1betaShipmentModelBreakRuleBreakRequest type array frequencyConstraints description Several `FrequencyConstraint` may apply. They must all be satisfied by the `BreakRequest`s of this `BreakRule`. See `FrequencyConstraint`. items $ref GoogleCloudOptimizationV1betaShipmentModelBreakRuleFrequencyConstraint type array type object GoogleCloudOptimizationV1betaShipmentModelBreakRuleBreakRequest description The sequence of breaks (i.e. their number and order) that apply to each vehicle must be known beforehand. The repeated `BreakRequest`s define that sequence, in the order in which they must occur. Their time windows (`earliest_start_time` / `latest_start_time`) may overlap, but they must be compatible with the order (this is checked). id GoogleCloudOptimizationV1betaShipmentModelBreakRuleBreakRequest properties earliestStartTime description Required. Lower bound (inclusive) on the start of the break. format google-datetime type string latestStartTime description Required. Upper bound (inclusive) on the start of the break. format google-datetime type string minDuration description Required. Minimum duration of the break. Must be positive. format google-duration type string type object GoogleCloudOptimizationV1betaShipmentModelBreakRuleFrequencyConstraint description One may further constrain the frequency and duration of the breaks specified above, by enforcing a minimum break frequency, such as "There must be a break of at least 1 hour every 12 hours". Assuming that this can be interpreted as "Within any sliding time window of 12h, there must be at least one break of at least one hour", that example would translate to the following `FrequencyConstraint`: ``` { min_break_duration { seconds: 3600 } # 1 hour. max_inter_break_duration { seconds: 39600 } # 11 hours (12 - 1 = 11). } ``` The timing and duration of the breaks in the solution will respect all such constraints, in addition to the time windows and minimum durations already specified in the `BreakRequest`. A `FrequencyConstraint` may in practice apply to non-consecutive breaks. For example, the following schedule honors the "1h every 12h" example: ``` 04:00 vehicle start .. performing travel and visits .. 09:00 1 hour break 10:00 end of the break .. performing travel and visits .. 12:00 20-min lunch break 12:20 end of the break .. performing travel and visits .. 21:00 1 hour break 22:00 end of the break .. performing travel and visits .. 23:59 vehicle end ``` id GoogleCloudOptimizationV1betaShipmentModelBreakRuleFrequencyConstraint properties maxInterBreakDuration description Required. Maximum allowed span of any interval of time in the route that does not include at least partially a break of `duration >= min_break_duration`. Must be positive. format google-duration type string minBreakDuration description Required. Minimum break duration for this constraint. Nonnegative. See description of `FrequencyConstraint`. format google-duration type string type object GoogleCloudOptimizationV1betaShipmentModelDurationDistanceMatrix description Specifies a duration and distance matrix from visit and vehicle start locations to visit and vehicle end locations. id GoogleCloudOptimizationV1betaShipmentModelDurationDistanceMatrix properties rows description Specifies the rows of the duration and distance matrix. It must have as many elements as ShipmentModel.duration_distance_matrix_src_tags. items $ref GoogleCloudOptimizationV1betaShipmentModelDurationDistanceMatrixRow type array vehicleStartTag description Tag defining to which vehicles this duration and distance matrix applies. If empty, this applies to all vehicles, and there can only be a single matrix. Each vehicle start must match exactly one matrix, i.e. exactly one of their `start_tags` field must match the `vehicle_start_tag` of a matrix (and of that matrix only). All matrices must have a different `vehicle_start_tag`. type string type object GoogleCloudOptimizationV1betaShipmentModelDurationDistanceMatrixRow description Specifies a row of the duration and distance matrix. id GoogleCloudOptimizationV1betaShipmentModelDurationDistanceMatrixRow properties durations description Duration values for a given row. It must have as many elements as ShipmentModel.duration_distance_matrix_dst_tags. items format google-duration type string type array meters description Distance values for a given row. If no costs or constraints refer to distances in the model, this can be left empty; otherwise it must have as many elements as `durations`. items format double type number type array type object GoogleCloudOptimizationV1betaShipmentModelPrecedenceRule description A precedence rule between two events (each event is the pickup or the delivery of a shipment): the "second" event has to start at least `offset_duration` after "first" has started. Several precedences can refer to the same (or related) events, e.g., "pickup of B happens after delivery of A" and "pickup of C happens after pickup of B". Furthermore, precedences only apply when both shipments are performed and are otherwise ignored. id GoogleCloudOptimizationV1betaShipmentModelPrecedenceRule properties firstIndex description Shipment index of the "first" event. This field must be specified. format int32 type integer firstIsDelivery description Indicates if the "first" event is a delivery. type boolean offsetDuration description The offset between the "first" and "second" event. It can be negative. format google-duration type string secondIndex description Shipment index of the "second" event. This field must be specified. format int32 type integer secondIsDelivery description Indicates if the "second" event is a delivery. type boolean type object GoogleCloudOptimizationV1betaShipmentRoute description A vehicle's route can be decomposed, along the time axis, like this (we assume there are n visits): ``` | | | | | T[2], | | | | Transition | Visit #0 | | | V[2], | | | | #0 | aka | T[1] | V[1] | ... | V[n-1] | T[n] | | aka T[0] | V[0] | | | V[n-2],| | | | | | | | T[n-1] | | | ^ ^ ^ ^ ^ ^ ^ ^ vehicle V[0].start V[0].end V[1]. V[1]. V[n]. V[n]. vehicle start (arrival) (departure) start end start end end ``` Note that we make a difference between: * "punctual events", such as the vehicle start and end and each visit's start and end (aka arrival and departure). They happen at a given second. * "time intervals", such as the visits themselves, and the transition between visits. Though time intervals can sometimes have zero duration, i.e. start and end at the same second, they often have a positive duration. Invariants: * If there are n visits, there are n+1 transitions. * A visit is always surrounded by a transition before it (same index) and a transition after it (index + 1). * The vehicle start is always followed by transition #0. * The vehicle end is always preceded by transition #n. Zooming in, here is what happens during a `Transition` and a `Visit`: ``` ---+-------------------------------------+-----------------------------+--> | TRANSITION[i] | VISIT[i] | | | | | * TRAVEL: the vehicle moves from | PERFORM the visit: | | VISIT[i-1].departure_location to | | | VISIT[i].arrival_location, which | * Spend some time: | | takes a given travel duration | the "visit duration". | | and distance | | | | * Load or unload | | * BREAKS: the driver may have | some quantities from the | | breaks (e.g. lunch break). | vehicle: the "demand". | | | | | * WAIT: the driver/vehicle does | | | nothing. This can happen for | | | many reasons, for example when | | | the vehicle reaches the next | | | event's destination before the | | | start of its time window | | | | | | * DELAY: *right before* the next | | | arrival. E.g. the vehicle and/or | | | driver spends time unloading. | | | | | ---+-------------------------------------+-----------------------------+--> ^ ^ ^ V[i-1].end V[i].start V[i].end ``` Lastly, here is how the TRAVEL, BREAKS, DELAY and WAIT can be arranged during a transition. * They don't overlap. * The DELAY is unique and *must* be a contiguous period of time right before the next visit (or vehicle end). Thus, it suffice to know the delay duration to know its start and end time. * The BREAKS are contiguous, non-overlapping periods of time. The response specifies the start time and duration of each break. * TRAVEL and WAIT are "preemptable": they can be interrupted several times during this transition. Clients can assume that travel happens "as soon as possible" and that "wait" fills the remaining time. A (complex) example: ``` TRANSITION[i] --++-----+-----------------------------------------------------------++--> || | | | | | | || || T | B | T | | B | | D || || r | r | r | W | r | W | e || || a | e | a | a | e | a | l || || v | a | v | i | a | i | a || || e | k | e | t | k | t | y || || l | | l | | | | || || | | | | | | || --++-----------------------------------------------------------------++--> ``` id GoogleCloudOptimizationV1betaShipmentRoute properties breaks description Breaks scheduled for the vehicle performing this route. The `breaks` sequence represents time intervals, each starting at the corresponding `start_time` and lasting `duration` seconds. items $ref GoogleCloudOptimizationV1betaShipmentRouteBreak type array delayBeforeVehicleEnd $ref GoogleCloudOptimizationV1betaShipmentRouteDelay deprecated True description **DEPRECATED** Delay occurring before the vehicle end. See TransitionAttributes.delay. endLoads deprecated True description **DEPRECATED** Vehicle loads upon arrival at its end location, for each type specified in Vehicle.capacities, `start_load_intervals`, `end_load_intervals` or demands. Exception: we omit loads for quantity types unconstrained by intervals and that don't have any non-zero demand on the route. items $ref GoogleCloudOptimizationV1betaCapacityQuantity type array hasTrafficInfeasibilities description When OptimizeToursRequest.consider_road_traffic, is set to true, this field indicates that inconsistencies in route timings are predicted using traffic-based travel duration estimates. There may be insufficient time to complete traffic-adjusted travel, delays, and breaks between visits, before the first visit, or after the last visit, while still satisfying the visit and vehicle time windows. For example, ``` start_time(previous_visit) + duration(previous_visit) + travel_duration(previous_visit, next_visit) > start_time(next_visit) ``` Arrival at next_visit will likely happen later than its current time window due the increased estimate of travel time `travel_duration(previous_visit, next_visit)` due to traffic. Also, a break may be forced to overlap with a visit due to an increase in travel time estimates and visit or break time window restrictions. type boolean routePolyline $ref GoogleCloudOptimizationV1betaShipmentRouteEncodedPolyline description The encoded polyline representation of the route. This field is only populated if OptimizeToursRequest.populate_polylines is set to true. transitions description Ordered list of transitions for the route. items $ref GoogleCloudOptimizationV1betaShipmentRouteTransition type array travelSteps deprecated True description **DEPRECATED** Ordered list of travel steps for the route. items $ref GoogleCloudOptimizationV1betaShipmentRouteTravelStep type array vehicleDetour deprecated True description **DEPRECATED** This field will only be populated at the ShipmentRoute.Visit level. Extra detour time due to the shipments visited on the route. It is equal to `vehicle_end_time` - `vehicle_start_time` - travel duration from the vehicle's start_location to its `end_location`. format google-duration type string vehicleEndTime description Time at which the vehicle finishes its route. format google-datetime type string vehicleIndex description Vehicle performing the route, identified by its index in the source `ShipmentModel`. format int32 type integer vehicleLabel description Label of the vehicle performing this route, equal to `ShipmentModel.vehicles(vehicle_index).label`, if specified. type string vehicleStartTime description Time at which the vehicle starts its route. format google-datetime type string visits description Ordered sequence of visits representing a route. visits[i] is the i-th visit in the route. If this field is empty, the vehicle is considered as unused. items $ref GoogleCloudOptimizationV1betaShipmentRouteVisit type array type object GoogleCloudOptimizationV1betaShipmentRouteBreak description Data representing the execution of a break. id GoogleCloudOptimizationV1betaShipmentRouteBreak properties duration description Duration of a break. format google-duration type string startTime description Start time of a break. format google-datetime type string type object GoogleCloudOptimizationV1betaShipmentRouteDelay deprecated True description **DEPRECATED** Time interval spent on the route resulting from a TransitionAttributes.delay. id GoogleCloudOptimizationV1betaShipmentRouteDelay properties duration description Duration of the delay. format google-duration type string startTime description Start of the delay. format google-datetime type string type object GoogleCloudOptimizationV1betaShipmentRouteEncodedPolyline description The encoded representation of a polyline. More information on polyline encoding can be found here: https://developers.google.com/maps/documentation/utilities/polylinealgorithm https://developers.google.com/maps/documentation/javascript/reference/geometry#encoding. id GoogleCloudOptimizationV1betaShipmentRouteEncodedPolyline properties points description String representing encoded points of the polyline. type string type object GoogleCloudOptimizationV1betaShipmentRouteTransition description Transition between two events on the route. See the description of ShipmentRoute. If the vehicle does not have a `start_location` and/or `end_location`, the corresponding travel metrics are 0. id GoogleCloudOptimizationV1betaShipmentRouteTransition properties delayDuration description Sum of the delay durations applied to this transition. If any, the delay starts exactly `delay_duration` seconds before the next event (visit or vehicle end). See TransitionAttributes.delay. format google-duration type string loads description Vehicle loads during this transition, for each type specified in Vehicle.capacities, `start_load_intervals`, `end_load_intervals`, or Shipment.demands. Exception: we omit loads for quantity types unconstrained by intervals and that don't have any non-zero demand on the route. The loads during the first transition (i.e., for each capacity type "t", transitions[0].loads[t]) are the starting loads of the vehicle route. The loads of each subsequent transition are determined, for i > 0, by ``` transitions[i].loads[t] = transitions[i-1].loads[t] + visits[i-1].demands[t]. ``` items $ref GoogleCloudOptimizationV1betaCapacityQuantity type array routePolyline $ref GoogleCloudOptimizationV1betaShipmentRouteEncodedPolyline description The encoded polyline representation of the route followed during the transition. This field is only populated if populate_transition_polylines is set to true. trafficInfoUnavailable description When traffic is requested via OptimizeToursRequest.consider_road_traffic, and the traffic info couldn't be retrieved for a `Transition`, this boolean is set to true. This may be temporary (rare hiccup in the realtime traffic servers) or permanent (no data for this location). type boolean travelDistanceMeters description Distance traveled during the transition. format double type number travelDuration description Travel duration during this transition. format google-duration type string type object GoogleCloudOptimizationV1betaShipmentRouteTravelStep deprecated True description **DEPRECATED** Travel between each visit, along the route: from the vehicle's `start_location` to the first visit's `arrival_location`, then from the first visit's `departure_location` to the second visit's `arrival_location`, and so on until the vehicle's `end_location`. This accounts only for the actual travel between visits, not counting the waiting time, the time spent performing a visit, nor the distance covered during a visit. Invariant: `travel_steps_size() == visits_size() + 1`. If the vehicle does not have a start_ and/or end_location, the corresponding travel metrics are 0 and/or empty. id GoogleCloudOptimizationV1betaShipmentRouteTravelStep properties distanceMeters description Distance traveled during the step. format double type number duration description Duration of the travel step. format google-duration type string routePolyline $ref GoogleCloudOptimizationV1betaShipmentRouteEncodedPolyline description The encoded polyline representation of the route followed during the step. This field is only populated if OptimizeToursRequest.populate_travel_step_polylines is set to true. trafficInfoUnavailable description When traffic is requested via OptimizeToursRequest.consider_road_traffic, and the traffic info couldn't be retrieved for a TravelStep, this boolean is set to true. This may be temporary (rare hiccup in the realtime traffic servers) or permanent (no data for this location). type boolean type object GoogleCloudOptimizationV1betaShipmentRouteVisit description A visit performed during a route. This visit corresponds to a pickup or a delivery of a `Shipment`. id GoogleCloudOptimizationV1betaShipmentRouteVisit properties arrivalLoads deprecated True description **DEPRECATED** Vehicle loads upon arrival at the visit location, for each type specified in Vehicle.capacities, `start_load_intervals`, `end_load_intervals` or `demands`. Exception: we omit loads for quantity types unconstrained by intervals and that don't have any non-zero demand on the route. items $ref GoogleCloudOptimizationV1betaCapacityQuantity type array delayBeforeStart $ref GoogleCloudOptimizationV1betaShipmentRouteDelay deprecated True description **DEPRECATED** Delay occurring before the visit starts. detour description Extra detour time due to the shipments visited on the route before the visit and to the potential waiting time induced by time windows. If the visit is a delivery, the detour is computed from the corresponding pickup visit and is equal to: ``` start_time(delivery) - start_time(pickup) - (duration(pickup) + travel duration from the pickup location to the delivery location). ``` Otherwise, it is computed from the vehicle `start_location` and is equal to: ``` start_time - vehicle_start_time - travel duration from the vehicle's `start_location` to the visit. ``` format google-duration type string isPickup description If true the visit corresponds to a pickup of a `Shipment`. Otherwise, it corresponds to a delivery. type boolean shipmentIndex description Index of the `shipments` field in the source ShipmentModel. format int32 type integer shipmentLabel description Copy of the corresponding `Shipment.label`, if specified in the `Shipment`. type string startTime description Time at which the visit starts. Note that the vehicle may arrive earlier than this at the visit location. Times are consistent with the `ShipmentModel`. format google-datetime type string visitLabel description Copy of the corresponding VisitRequest.label, if specified in the `VisitRequest`. type string visitRequestIndex description Index of `VisitRequest` in either the pickup or delivery field of the `Shipment` (see `is_pickup`). format int32 type integer type object GoogleCloudOptimizationV1betaShipmentTypeIncompatibility description Specifies incompatibilties between shipments depending on their shipment_type. The appearance of incompatible shipments on the same route is restricted based on the incompatibility mode. id GoogleCloudOptimizationV1betaShipmentTypeIncompatibility properties incompatibilityMode description Mode applied to the incompatibility. enum INCOMPATIBILITY_MODE_UNSPECIFIED NOT_PERFORMED_BY_SAME_VEHICLE NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY enumDescriptions Unspecified incompatibility mode. This value should never be used. In this mode, two shipments with incompatible types can never share the same vehicle. For two shipments with incompatible types with the `NOT_IN_SAME_VEHICLE_SIMULTANEOUSLY` incompatibility mode: * If both are pickups only (no deliveries) or deliveries only (no pickups), they cannot share the same vehicle at all. * If one of the shipments has a delivery and the other a pickup, the two shipments can share the same vehicle iff the former shipment is delivered before the latter is picked up. type string types description List of incompatible types. Two shipments having different `shipment_types` among those listed are "incompatible". items type string type array type object GoogleCloudOptimizationV1betaShipmentTypeRequirement description Specifies requirements between shipments based on their shipment_type. The specifics of the requirement are defined by the requirement mode. id GoogleCloudOptimizationV1betaShipmentTypeRequirement properties dependentShipmentTypes description All shipments with a type in the `dependent_shipment_types` field require at least one shipment of type `required_shipment_type_alternatives` to be visited on the same route. NOTE: Chains of requirements such that a `shipment_type` depends on itself are not allowed. items type string type array requiredShipmentTypeAlternatives description List of alternative shipment types required by the `dependent_shipment_types`. items type string type array requirementMode description Mode applied to the requirement. enum REQUIREMENT_MODE_UNSPECIFIED PERFORMED_BY_SAME_VEHICLE IN_SAME_VEHICLE_AT_PICKUP_TIME IN_SAME_VEHICLE_AT_DELIVERY_TIME enumDescriptions Unspecified requirement mode. This value should never be used. In this mode, all "dependent" shipments must share the same vehicle as at least one of their "required" shipments. With the IN_SAME_VEHICLE_AT_PICKUP_TIME mode, all "dependent" shipments need to have at least one "required" shipment on their vehicle at the time of their pickup. A "dependent" shipment pickup must therefore have either: * A delivery-only "required" shipment delivered on the route after, or * A "required" shipment picked up on the route before it, and if the "required" shipment has a delivery, this delivery must be performed after the "dependent" shipment's pickup. Same as before, except the "dependent" shipments need to have a "required" shipment on their vehicle at the time of their *delivery*. type string type object GoogleCloudOptimizationV1betaShipmentVisitRequest description Request for a visit which can be done by a vehicle: it has a geo-location (or two, see below), opening and closing times represented by time windows, and a service duration time (time spent by the vehicle once it has arrived to pickup or drop off goods). id GoogleCloudOptimizationV1betaShipmentVisitRequest properties arrivalLocation $ref GoogleTypeLatLng description The geo-location where the vehicle arrives when performing this `VisitRequest`. If the shipment model has duration distance matrices, `arrival_location` must not be specified. cost description Cost to service this visit request on a vehicle route. This can be used to pay different costs for each alternative pickup or delivery of a shipment. This cost must be in the same unit as `Shipment.penalty_cost` and must not be negative. format double type number demands description Demand of the visit request which may be broken up into several `CapacityQuantity` fields, one for each quantity type. The corresponding quantities will be subtracted from the vehicle capacity if the visit request is a pickup or added to the capacity if it is a delivery (see Vehicle.capacities). In particular, this means that the `CapacityQuantity` used in different visit requests and in the vehicle capacities must all be compatible. If a demand is not specified for a given type, it will be considered as null. `CapacityQuantity` types in the repeated field must be unique. The demand is added to the one specified in the shipment to which the visit request belongs (see Shipment.demands). items $ref GoogleCloudOptimizationV1betaCapacityQuantity type array departureLocation $ref GoogleTypeLatLng description The geo-location where the vehicle departs after completing this `VisitRequest`. Can be omitted if it is the same as `arrival_location`. If the shipment model has duration distance matrices, `departure_location` must not be specified. duration description Duration of the visit, i.e. time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see `time_windows`). format google-duration type string label description Specifies a label for this `VisitRequest`. This label is reported in the response as `visit_label` in the corresponding ShipmentRoute.Visit. type string tags description Specifies tags attached to the visit request. Empty or duplicate strings are not allowed. items type string type array timeWindows description Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before TimeWindow.start_time. The absence of `TimeWindow` means that the vehicle can perform this visit at any time. Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window. items $ref GoogleCloudOptimizationV1betaTimeWindow type array visitTypes description Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see Vehicle.extra_visit_duration_for_visit_type). A type can only appear once. items type string type array type object GoogleCloudOptimizationV1betaSkippedShipment description Specifies details of unperformed shipments in a solution. For trivial cases and/or if we are able to identify the cause for skipping, we report the reason here. id GoogleCloudOptimizationV1betaSkippedShipment properties index description The index corresponds to the index of the shipment in the source `ShipmentModel`. format int32 type integer label description Copy of the corresponding Shipment.label, if specified in the `Shipment`. type string reasons description A list of reasons that explain why the shipment was skipped. See comment above `Reason`. items $ref GoogleCloudOptimizationV1betaSkippedShipmentReason type array type object GoogleCloudOptimizationV1betaSkippedShipmentReason description If we can explain why the shipment was skipped, reasons will be listed here. If the reason is not the same for all vehicles, `reason` will have more than 1 element. A skipped shipment cannot have duplicate reasons, i.e. where all fields are the same except for `example_vehicle_index`. Example: ``` reasons { code: DEMAND_EXCEEDS_VEHICLE_CAPACITY example_vehicle_index: 1 example_exceeded_capacity_type: "Apples" } reasons { code: DEMAND_EXCEEDS_VEHICLE_CAPACITY example_vehicle_index: 3 example_exceeded_capacity_type: "Pears" } reasons { code: CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT example_vehicle_index: 1 } ``` The skipped shipment is incompatible with all vehicles. The reasons may be different for all vehicles but at least one vehicle's "Apples" capacity would be exceeded (including vehicle 1), at least one vehicle's "Pears" capacity would be exceeded (including vehicle 3) and at least one vehicle's distance limit would be exceeded (including vehicle 1). id GoogleCloudOptimizationV1betaSkippedShipmentReason properties code description Refer to the comments of Code. enum CODE_UNSPECIFIED NO_VEHICLE DEMAND_EXCEEDS_VEHICLE_CAPACITY CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TRAVEL_DURATION_LIMIT CANNOT_BE_PERFORMED_WITHIN_VEHICLE_TIME_WINDOWS VEHICLE_NOT_ALLOWED enumDescriptions This should never be used. If we are unable to understand why a shipment was skipped, we simply return an empty set of reasons. There is no vehicle in the model making all shipments infeasible. The demand of the shipment exceeds a vehicle's capacity for some capacity types, one of which is `example_exceeded_capacity_type`. The minimum distance necessary to perform this shipment, i.e. from the vehicle's `start_location` to the shipment's pickup and/or delivery locations and to the vehicle's end location exceeds the vehicle's `route_distance_limit`. Note that for this computation we use the geodesic distances. The minimum time necessary to perform this shipment, including travel time, wait time and service time exceeds the vehicle's `route_duration_limit`. Note: travel time is computed in the best-case scenario, namely as geodesic distance x 36 m/s (roughly 130 km/hour). Same as above but we only compare minimum travel time and the vehicle's `travel_duration_limit`. The vehicle cannot perform this shipment in the best-case scenario (see `CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT` for time computation) if it starts at its earliest start time: the total time would make the vehicle end after its latest end time. The `allowed_vehicle_indices` field of the shipment is not empty and this vehicle does not belong to it. type string exampleExceededCapacityType description If the reason code is `DEMAND_EXCEEDS_VEHICLE_CAPACITY`, documents one capacity type that is exceeded. type string exampleVehicleIndex description If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle. format int32 type integer type object GoogleCloudOptimizationV1betaTimeWindow description Time windows constrain the time of an event, such as the arrival time at a visit, or the start and end time of a vehicle. Hard time window bounds, `start_time` and `end_time`, enforce the earliest and latest time of the event, such that `start_time <= event_time <= end_time`. The soft time window lower bound, `soft_start_time`, expresses a preference for the event to happen at or after `soft_start_time` by incurring a cost proportional to how long before soft_start_time the event occurs. The soft time window upper bound, `soft_end_time`, expresses a preference for the event to happen at or before `soft_end_time` by incurring a cost proportional to how long after `soft_end_time` the event occurs. `start_time`, `end_time`, `soft_start_time` and `soft_end_time` should be within the global time limits (see ShipmentModel.global_start_time and ShipmentModel.global_end_time) and should respect: ``` 0 <= `start_time` <= `end_time` and 0 <= `start_time` <= `soft_start_time` and 0 <= `soft_end_time` <= `end_time`. ``` id GoogleCloudOptimizationV1betaTimeWindow properties costPerHourAfterSoftEndTime description A cost per hour added to other costs in the model if the event occurs after `soft_end_time`, computed as: ``` max(0, t.seconds - soft_end_time.seconds) * cost_per_hour_after_soft_end_time / 3600, t being the time of the event. ``` This cost must be positive, and the field can only be set if `soft_end_time` has been set. format double type number costPerHourBeforeSoftStartTime description A cost per hour added to other costs in the model if the event occurs before soft_start_time, computed as: ``` max(0, soft_start_time - t.seconds) * cost_per_hour_before_soft_start_time / 3600, t being the time of the event. ``` This cost must be positive, and the field can only be set if soft_start_time has been set. format double type number endTime description The hard time window end time. If unspecified it will be set to `ShipmentModel.global_end_time`. format google-datetime type string softEndTime description The soft end time of the time window. format google-datetime type string softStartTime description The soft start time of the time window. format google-datetime type string startTime description The hard time window start time. If unspecified it will be set to `ShipmentModel.global_start_time`. format google-datetime type string type object GoogleCloudOptimizationV1betaTransitionAttributes description Specifies attributes of transitions between two consecutive visits on a route. Several `TransitionAttributes` may apply to the same transition: in that case, all extra costs add up and the strictest constraint or limit applies (following natural "AND" semantics). id GoogleCloudOptimizationV1betaTransitionAttributes properties cost description Specifies a cost for performing this transition. This is in the same unit as all other costs in the model and must not be negative. It is applied on top of all other existing costs. format double type number costPerKilometer description Specifies a cost per kilometer applied to the distance traveled while performing this transition. It adds up to any Vehicle.cost_per_kilometer specified on vehicles. format double type number delay description Specifies a delay incurred when performing this transition. This delay always occurs *after* finishing the source visit and *before* starting the destination visit. format google-duration type string distanceLimit $ref GoogleCloudOptimizationV1betaDistanceLimit description Specifies a limit on the distance traveled while performing this transition. As of 06/2021, only soft limits are supported. dstTag description A destination visit or vehicle end matches iff its VisitRequest.tags or Vehicle.end_tags either contains `dst_tag` or does not contain `excluded_dst_tag` (depending on which of these two fields is non-empty). type string excludedDstTag description See `dst_tag`. Exactly one of `dst_tag` and `excluded_dst_tag` must be non-empty. type string excludedSrcTag description See `src_tag`. Exactly one of `src_tag` and `excluded_src_tag` must be non-empty. type string srcTag description Tags defining the set of (src->dst) transitions these attributes apply to. A source visit or vehicle start matches iff its VisitRequest.tags or Vehicle.start_tags either contains `src_tag` or does not contain `excluded_src_tag` (depending on which of these two fields is non-empty). type string type object GoogleCloudOptimizationV1betaVehicle description Models a vehicle in a shipment problem. Solving a shipment problem will build a route starting from `start_location` and ending at `end_location` for this vehicle. A route is a sequence of visits (see `ShipmentRoute`). id GoogleCloudOptimizationV1betaVehicle properties breakRuleIndices description Indices in the `break_rule` field in the source ShipmentModel. They correspond to break rules enforced on the vehicle. As of 2018/03, at most one rule index per vehicle can be specified. items format int32 type integer type array capacities description Capacities of the vehicle according to different quantity types (weight, volume, # of pallets for instance). They must be compatible with the Shipment.demands and VisitRequest.demands fields. Undefined capacities are infinite. `CapacityQuantity` types in this field must be unique. items $ref GoogleCloudOptimizationV1betaCapacityQuantity type array costPerHour description Vehicle costs: all costs add up and must be in the same unit as Shipment.penalty_cost. Cost per hour of the vehicle route. This cost is applied to the total time taken by the route, and includes travel time, waiting time, and visit time. Using `cost_per_hour` instead of just `cost_per_traveled_hour` may result in additional latency. format double type number costPerKilometer description Cost per kilometer of the vehicle route. This cost is applied to the distance reported in the ShipmentRoute.transitions and does not apply to any distance implicitly traveled from the `arrival_location` to the `departure_location` of a single `VisitRequest`. format double type number costPerTraveledHour description Cost per traveled hour of the vehicle route. This cost is applied only to travel time taken by the route (i.e., that reported in ShipmentRoute.transitions), and excludes waiting time and visit time. format double type number endLoadIntervals description The allowed intervals of load (i.e. consumed capacity) of different quantity types with which the vehicle must end its route. They must be compatible with the Shipment.demands, VisitRequest.demands, and Vehicle.capacities fields. Types must be unique. items $ref GoogleCloudOptimizationV1betaCapacityQuantityInterval type array endLocation $ref GoogleTypeLatLng description Geographic location where the vehicle ends after it has completed its last `VisitRequest`. If not specified the vehicle's `ShipmentRoute` ends immediately when it completes its last `VisitRequest`. If the shipment model has duration and distance matrices, `end_location` must not be specified. endTags description Specifies tags attached to the end of the vehicle's route. Empty or duplicate strings are not allowed. items type string type array endTimeWindows description Time windows during which the vehicle may arrive at its end location. They must be within the global time limits (see ShipmentModel.global_* fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window. items $ref GoogleCloudOptimizationV1betaTimeWindow type array extraVisitDurationForVisitType additionalProperties format google-duration type string description Specifies a map from visit_types strings to durations. The duration is time in addition to VisitRequest.duration to be taken at visits with the specified `visit_types`. This extra visit duration adds cost if `cost_per_hour` is specified. Keys (i.e. `visit_types`) cannot be empty strings. If a visit request has multiple types, a duration will be added for each type in the map. type object fixedCost description Fixed cost applied if this vehicle is used to handle a shipment. format double type number ignore description If true, `used_if_route_is_empty` must be false, and this vehicle will remain unused. If a shipment is performed by an ignored vehicle in `injected_first_solution_routes`, it is skipped in the first solution but is free to be performed in the response. If a shipment is performed by an ignored vehicle in `injected_solution_constraint` and any related pickup/delivery is constrained to remain on the vehicle (i.e., not relaxed to level `RELAX_ALL_AFTER_THRESHOLD`), it is skipped in the response. If a shipment has a non-empty `allowed_vehicle_indices` field and all of the allowed vehicles are ignored, it is skipped in the response. type boolean label description Specifies a label for this vehicle. This label is reported in the response as the `vehicle_label` of the corresponding ShipmentRoute. type string routeDistanceLimit $ref GoogleCloudOptimizationV1betaDistanceLimit description Limit applied to the total distance of the vehicle's route. In a given `OptimizeToursResponse`, the route distance is the sum of all its transitions.travel_distance_meters. routeDurationLimit $ref GoogleCloudOptimizationV1betaVehicleDurationLimit description Limit applied to the total duration of the vehicle's route. In a given `OptimizeToursResponse`, the route duration of a vehicle is the difference between its `vehicle_end_time` and `vehicle_start_time`. startLoadIntervals description The allowed intervals of load (i.e. consumed capacity) of different quantity types with which the vehicle must start its route. They must be compatible with the Shipment.demands, VisitRequest.demands, and Vehicle.capacities fields. Types must be unique. items $ref GoogleCloudOptimizationV1betaCapacityQuantityInterval type array startLocation $ref GoogleTypeLatLng description Geographic location where the vehicle starts before picking up any shipments. If not specified, the vehicle starts at its first pickup. If the shipment model has duration and distance matrices, `start_location` must not be specified. startTags description Specifies tags attached to the start of the vehicle's route. Empty or duplicate strings are not allowed. items type string type array startTimeWindows description Time windows during which the vehicle may depart its start location. They must be within the global time limits (see ShipmentModel.global_* fields). If unspecified, there is no limitation besides those global time limits. Time windows belonging to the same repeated field must be disjoint, i.e. no time window can overlap with or be adjacent to another, and they must be in chronological order. `cost_per_hour_after_soft_end_time` and `soft_end_time` can only be set if there is a single time window. items $ref GoogleCloudOptimizationV1betaTimeWindow type array travelDurationLimit $ref GoogleCloudOptimizationV1betaVehicleDurationLimit description Limit applied to the travel duration of the vehicle's route. In a given `OptimizeToursResponse`, the route travel duration is the sum of all its transitions.travel_duration. travelDurationMultiple description Specifies a multiplicative factor that can be used to increase or decrease travel times of this vehicle. For example, setting this to 2.0 means that this vehicle is slower and has travel times that are twice what they are for standard vehicles. This multiple does not affect visit durations. It does affect cost if `cost_per_hour` or `cost_per_traveled_hour` are specified. This must be in the range [0.001, 1000.0]. If unset, the vehicle is standard, and this multiple is considered 1.0. WARNING: Travel times will be rounded to the nearest second after this multiple is applied but before performing any numerical operations, thus, a small multiple may result in a loss of precision. See also `extra_visit_duration_for_visit_type` below. format double type number travelMode description The travel mode which affects the roads usable by the vehicle and its speed. See also `travel_duration_multiple`. enum TRAVEL_MODE_UNSPECIFIED DRIVING WALKING BICYCLING enumDescriptions Unspecified travel mode, equivalent to `DRIVING`. Travel mode corresponding to driving directions (car, ...). Travel mode corresponding to walking directions. Travel mode corresponding to bicycling directions. type string unloadingPolicy description Unloading policy enforced on the vehicle. enum UNLOADING_POLICY_UNSPECIFIED LAST_IN_FIRST_OUT FIRST_IN_FIRST_OUT enumDescriptions Unspecified unloading policy; deliveries must just occur after their corresponding pickups. Deliveries must occur in reverse order of pickups Deliveries must occur in the same order as pickups type string usedIfRouteIsEmpty description This field only applies to vehicles when their route does not serve any shipments. It indicates if the vehicle should be considered as used or not in this case. If true, the vehicle goes from its start to its end location even if it doesn't serve any shipments, and time and distance costs resulting from its start --> end travel are taken into account. Otherwise, it doesn't travel from its start to its end location, and no `break_rule` or delay (from `TransitionAttributes`) are scheduled for this vehicle. In this case, the vehicle's `ShipmentRoute` doesn't contain any information except for the vehicle index and label. type boolean type object GoogleCloudOptimizationV1betaVehicleDurationLimit description A limit defining a maximum duration of the route of a vehicle. It can be either hard or soft. When a soft limit field is defined, both the soft max threshold and its associated cost must be defined together. id GoogleCloudOptimizationV1betaVehicleDurationLimit properties costPerHourAfterSoftMax description Cost per hour incurred if the `soft_max_duration` threshold is violated. The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows: ``` cost_per_hour_after_soft_max * (duration - soft_max_duration) ``` The cost must be nonnegative. format double type number costPerSquareHourAfterQuadraticSoftMax description Cost per square hour incurred if the `quadratic_soft_max_duration` threshold is violated. The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows: ``` cost_per_square_hour_after_quadratic_soft_max * (duration - quadratic_soft_max_duration)^2 ``` The cost must be nonnegative. format double type number maxDuration description A hard limit constraining the duration to be at most max_duration. format google-duration type string quadraticSoftMaxDuration description A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit. If defined, `quadratic_soft_max_duration` must be nonnegative. If `max_duration` is also defined, `quadratic_soft_max_duration` must be less than `max_duration`, and the difference must be no larger than one day: `max_duration - quadratic_soft_max_duration <= 86400 seconds` format google-duration type string softMaxDuration description A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit. If defined, `soft_max_duration` must be nonnegative. If max_duration is also defined, `soft_max_duration` must be less than max_duration. format google-duration type string type object GoogleLongrunningOperation description This resource represents a long-running operation that is the result of a network API call. id GoogleLongrunningOperation properties done description If 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. type boolean error $ref GoogleRpcStatus description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object GoogleRpcBadRequest description Describes violations in a client request. This error type focuses on the syntactic aspects of the request. id GoogleRpcBadRequest properties fieldViolations description Describes all violations in a client request. items $ref GoogleRpcBadRequestFieldViolation type array type object GoogleRpcBadRequestFieldViolation description A message type used to describe a single bad request field. id GoogleRpcBadRequestFieldViolation properties description description A description of why the request element is bad. type string field description A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. Consider the following: message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; } optional string email = 1; repeated EmailType type = 2; } string full_name = 1; repeated EmailAddress email_addresses = 2; } In this example, in proto `field` could take one of the following values: * `full_name` for a violation in the `full_name` value * `email_addresses[1].email` for a violation in the `email` field of the first `email_addresses` message * `email_addresses[3].type[2]` for a violation in the second `type` value in the third `email_addresses` message. In JSON, the same values are represented as: * `fullName` for a violation in the `fullName` value * `emailAddresses[1].email` for a violation in the `email` field of the first `emailAddresses` message * `emailAddresses[3].type[2]` for a violation in the second `type` value in the third `emailAddresses` message. type string localizedMessage $ref GoogleRpcLocalizedMessage description Provides a localized error message for field-level errors that is safe to return to the API consumer. reason description The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. type string type object GoogleRpcLocalizedMessage description Provides a localized error message that is safe to return to the user which can be attached to an RPC error. id GoogleRpcLocalizedMessage properties locale description The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" type string message description The localized error message in the above locale. type string type object GoogleRpcStatus description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id GoogleRpcStatus properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object GoogleTypeLatLng description An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. id GoogleTypeLatLng properties latitude description The latitude in degrees. It must be in the range [-90.0, +90.0]. format double type number longitude description The longitude in degrees. It must be in the range [-180.0, +180.0]. format double type number type object Proto2BridgeMessageSet description This is proto2's version of MessageSet. id Proto2BridgeMessageSet properties type object UtilStatusProto description Wire-format for a Status object id UtilStatusProto properties canonicalCode description The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; format int32 type integer code description Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1; format int32 type integer message description Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3; type string messageSet $ref Proto2BridgeMessageSet description message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5; space description The following are usually only present when code != 0 Space to which this status belongs copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string space = 2; type string type object servicePath title Cloud Optimization API version v1beta version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/cloudoptimization-v1eap	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://cloudoptimization.googleapis.com/ batchPath batch canonicalName Cloud Optimization API description Cloud Optimization API provides a portfolio of solvers to address common optimization use cases starting with optimal route planning for vehicle fleets. discoveryVersion v1 documentationLink https://cloud.google.com/optimization/docs/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id cloudoptimization:v1eap kind discovery#restDescription mtlsRootUrl https://cloudoptimization.mtls.googleapis.com/ name cloudoptimization ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations resources operations methods get description Gets 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. flatPath v1eap/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id cloudoptimization.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1eap/{+name} response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform operations methods get description Gets 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. flatPath v1eap/projects/{projectsId}/operations/{operationsId} httpMethod GET id cloudoptimization.projects.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/operations/[^/]+$ required True type string path v1eap/{+name} response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform revision 20250117 rootUrl https://cloudoptimization.googleapis.com/ schemas GoogleCloudOptimizationV1AsyncModelMetadata description The long running operation metadata for async model related methods. id GoogleCloudOptimizationV1AsyncModelMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the current operation. enum STATE_UNSPECIFIED RUNNING SUCCEEDED CANCELLED FAILED enumDescriptions The default value. This value is used if the state is omitted. Request is being processed. The operation completed successfully. The operation was cancelled. The operation has failed. type string stateMessage description A message providing more details about the current state of the operation. For example, the error message if the operation is failed. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudOptimizationV1BatchOptimizeToursResponse description Response to a `BatchOptimizeToursRequest`. This is returned in the LRO Operation after the operation is complete. id GoogleCloudOptimizationV1BatchOptimizeToursResponse properties type object GoogleCloudOptimizationV1RunOptimizerMetadata description The long running operation metadata for `RunOptimizer` method. id GoogleCloudOptimizationV1RunOptimizerMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the current operation. enum STATE_UNSPECIFIED RUNNING SUCCEEDED FAILED enumDescriptions The default value. This value is used if the state is omitted. Request is being processed. The operation succeeded. The operation failed. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudOptimizationV1RunOptimizerResponse description The response message for `RunOptimizer` method. id GoogleCloudOptimizationV1RunOptimizerResponse properties solution description The name of the solution for this optimization. Format: "projects/{project}/locations/{location}/workspaces/{workspace}/solutions/{solution}" type string type object GoogleCloudOptimizationV1betaAsyncModelMetadata description The long running operation metadata for async model related methods. id GoogleCloudOptimizationV1betaAsyncModelMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the current operation. enum STATE_UNSPECIFIED RUNNING SUCCEEDED CANCELLED FAILED enumDescriptions The default value. This value is used if the state is omitted. Request is being processed. The operation completed successfully. The operation was cancelled. The operation has failed. type string stateMessage description A message providing more details about the current state of the operation. For example, the error message if the operation is failed. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudOptimizationV1betaBatchOptimizeToursResponse description Response to a `BatchOptimizeToursRequest`. This is returned in the LRO Operation after the operation is complete. id GoogleCloudOptimizationV1betaBatchOptimizeToursResponse properties type object GoogleLongrunningOperation description This resource represents a long-running operation that is the result of a network API call. id GoogleLongrunningOperation properties done description If 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. type boolean error $ref GoogleRpcStatus description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object GoogleRpcBadRequest description Describes violations in a client request. This error type focuses on the syntactic aspects of the request. id GoogleRpcBadRequest properties fieldViolations description Describes all violations in a client request. items $ref GoogleRpcBadRequestFieldViolation type array type object GoogleRpcBadRequestFieldViolation description A message type used to describe a single bad request field. id GoogleRpcBadRequestFieldViolation properties description description A description of why the request element is bad. type string field description A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. Consider the following: message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; } optional string email = 1; repeated EmailType type = 2; } string full_name = 1; repeated EmailAddress email_addresses = 2; } In this example, in proto `field` could take one of the following values: * `full_name` for a violation in the `full_name` value * `email_addresses[1].email` for a violation in the `email` field of the first `email_addresses` message * `email_addresses[3].type[2]` for a violation in the second `type` value in the third `email_addresses` message. In JSON, the same values are represented as: * `fullName` for a violation in the `fullName` value * `emailAddresses[1].email` for a violation in the `email` field of the first `emailAddresses` message * `emailAddresses[3].type[2]` for a violation in the second `type` value in the third `emailAddresses` message. type string localizedMessage $ref GoogleRpcLocalizedMessage description Provides a localized error message for field-level errors that is safe to return to the API consumer. reason description The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. type string type object GoogleRpcLocalizedMessage description Provides a localized error message that is safe to return to the user which can be attached to an RPC error. id GoogleRpcLocalizedMessage properties locale description The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" type string message description The localized error message in the above locale. type string type object GoogleRpcStatus description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id GoogleRpcStatus properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object Proto2BridgeMessageSet description This is proto2's version of MessageSet. id Proto2BridgeMessageSet properties type object UtilStatusProto description Wire-format for a Status object id UtilStatusProto properties canonicalCode description The canonical error code (see codes.proto) that most closely corresponds to this status. This may be missing, and in the common case of the generic space, it definitely will be. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 canonical_code = 6; format int32 type integer code description Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional int32 code = 1; format int32 type integer message description Detail message copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string message = 3; type string messageSet $ref Proto2BridgeMessageSet description message_set associates an arbitrary proto message with the status. copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional proto2.bridge.MessageSet message_set = 5; space description The following are usually only present when code != 0 Space to which this status belongs copybara:strip_begin(b/383363683) copybara:strip_end_and_replace optional string space = 2; type string type object servicePath title Cloud Optimization API version v1eap version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/cloudprivatecatalog-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/cloudprivatecatalog-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/cloudscheduler-	values_changed root['revision'] new_value 20250205 old_value 20250117
prod/cloudscheduler-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250117
prod/cloudscheduler-v1beta1	values_changed root['revision'] new_value 20250205 old_value 20250117
prod/cloudvideosearch-	values_changed root['revision'] new_value 20250131 old_value 20250124
prod/cloudvideosearch-v1	values_changed root['revision'] new_value 20250131 old_value 20250124
prod/commentanalyzer-	values_changed root['revision'] new_value 20250204 old_value 20250126
prod/commentanalyzer-v1alpha1	values_changed root['revision'] new_value 20250204 old_value 20250126
prod/config-v1	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/config-v1alpha2	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/connectgateway-	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/connectgateway-v1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/connectgateway-v1beta1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/containeranalysis-	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/containeranalysis-v1	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/containeranalysis-v1alpha1	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/containeranalysis-v1beta1	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/containersecurity-	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/containersecurity-v1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/containersecurity-v1beta	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/containersecurity-v1main	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/content-abusereporting-pa-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-abusereporting-pa-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-acceleratedmobilepageurl-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-acceleratedmobilepageurl-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-actions-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/content-actions-v2	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/content-actions-v2alpha	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/content-actions-v3	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/content-adexchangebuyer-v2beta1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/content-analytics-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-analyticsadmin-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-analyticsadmin-v1alpha	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-analyticsadmin-v1beta	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-analyticsdata-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-analyticsdata-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-analyticsdata-v1alpha	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-analyticsdata-v1beta	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-appengine-	values_changed root['revision'] new_value 20250131 old_value 20250127
prod/content-appengine-v1	values_changed root['revision'] new_value 20250131 old_value 20250127
prod/content-appengine-v1alpha	values_changed root['revision'] new_value 20250131 old_value 20250127
prod/content-appengine-v1beta	values_changed root['revision'] new_value 20250131 old_value 20250127
prod/content-blogger-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/content-blogger-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/content-blogger-v2	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/content-blogger-v3	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/content-books-	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/content-books-v1	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/content-canary-cloudsearch-	values_changed root['revision'] new_value 20250205 old_value 20250129
prod/content-canary-cloudsearch-v1	values_changed root['revision'] new_value 20250205 old_value 20250129
prod/content-classroom-	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/content-classroom-v1	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/content-conversation-	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/content-conversation-v2	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/content-conversation-v2beta1	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/content-conversation-v3beta1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/content-dataflow-	dictionary_item_added root['schemas']['TemplateMetadata']['properties']['yamlDefinition'] values_changed root['revision'] new_value 20250131 old_value 20250125 iterable_item_added root['schemas']['SDKInfo']['properties']['language']['enum'][4] YAML root['schemas']['SDKInfo']['properties']['language']['enumDescriptions'][4] YAML.
prod/content-dataflow-v1b3	dictionary_item_added root['schemas']['TemplateMetadata']['properties']['yamlDefinition'] values_changed root['revision'] new_value 20250131 old_value 20250125 iterable_item_added root['schemas']['SDKInfo']['properties']['language']['enum'][4] YAML root['schemas']['SDKInfo']['properties']['language']['enumDescriptions'][4] YAML.
prod/content-dataproc-	values_changed root['revision'] new_value 20250122 old_value 20250131
prod/content-dataproc-v1	dictionary_item_removed root['schemas']['GceClusterConfig']['properties']['resourceManagerTags'] values_changed root['revision'] new_value 20250122 old_value 20250131
prod/content-dataproc-v1beta2	values_changed root['revision'] new_value 20250122 old_value 20250131
prod/content-datastore-	values_changed root['revision'] new_value 20250204 old_value 20250120 root['schemas']['RunQueryResponse']['properties']['batch']['description'] new_value A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false. old_value A batch of query results (always present).
prod/content-datastore-v1	values_changed root['revision'] new_value 20250204 old_value 20250120 root['schemas']['RunQueryResponse']['properties']['batch']['description'] new_value A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false. old_value A batch of query results (always present).
prod/content-datastore-v1beta1	values_changed root['revision'] new_value 20250204 old_value 20250120
prod/content-datastore-v1beta3	values_changed root['revision'] new_value 20250204 old_value 20250120 root['schemas']['RunQueryResponse']['properties']['batch']['description'] new_value A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false. old_value A batch of query results (always present).
prod/content-dialogflow-	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/content-dialogflow-v2beta1	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/content-dialogflow-v3	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/content-dialogflow-v3beta1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/content-dlp-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/content-dlp-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/content-dlp-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/content-earthengine-	values_changed root['revision'] new_value 20250203 old_value 20250205
prod/content-earthengine-v1	values_changed root['revision'] new_value 20250203 old_value 20250205
prod/content-earthengine-v1alpha	values_changed root['revision'] new_value 20250203 old_value 20250205
prod/content-earthengine-v1beta	values_changed root['revision'] new_value 20250203 old_value 20250205
prod/content-file-v1	values_changed root['revision'] new_value 20250129 old_value 20250127 root['schemas']['PerformanceConfig']['properties']['iopsPerTb']['description'] new_value Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. old_value Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error.
prod/content-file-v1beta1	values_changed root['revision'] new_value 20250129 old_value 20250127 root['schemas']['PerformanceConfig']['properties']['iopsPerTb']['description'] new_value Provision IOPS dynamically based on the capacity of the instance. Provisioned IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. old_value Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error.
prod/content-file-v1p1alpha1	values_changed root['revision'] new_value 20250129 old_value 20250127
prod/content-firebase-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-firebase-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-firebase-v1alpha	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-firebase-v1beta1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-firebaserules-	values_changed root['revision'] new_value 20250127 old_value 20250113
prod/content-firebaserules-v1	values_changed root['revision'] new_value 20250127 old_value 20250113
prod/content-gmail-v1	values_changed root['revision'] new_value 20250203 old_value 20250127
prod/content-iap-	values_changed root['revision'] new_value 20250203 old_value 20250128
prod/content-iap-v1	values_changed root['revision'] new_value 20250203 old_value 20250128
prod/content-logging-	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/content-logging-v1	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/content-logging-v1beta3	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/content-logging-v2	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/content-logging-v2beta1	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/content-migrate-	values_changed root['revision'] new_value 20250204 old_value 20250202
prod/content-migrate-v1beta1	values_changed root['revision'] new_value 20250204 old_value 20250202
prod/content-ml-	values_changed root['revision'] new_value 20250201 old_value 20250118
prod/content-ml-v1	values_changed root['revision'] new_value 20250201 old_value 20250118
prod/content-monitoring-	values_changed root['resources']['projects']['resources']['snoozes']['methods']['list']['parameters']['filter']['description'] new_value Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" old_value Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: ``` interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" ``` root['revision'] new_value 20250130 old_value 20250125
prod/content-monitoring-v1	dictionary_item_added root['schemas']['TemplateVariableCondition'] root['schemas']['VisibilityCondition'] root['schemas']['Widget']['properties']['visibilityCondition'] values_changed root['revision'] new_value 20250130 old_value 20250125
prod/content-monitoring-v3	values_changed root['resources']['projects']['resources']['snoozes']['methods']['list']['parameters']['filter']['description'] new_value Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" old_value Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: ``` interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" ``` root['revision'] new_value 20250130 old_value 20250125
prod/content-people-	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/content-people-pa-	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/content-people-pa-v1	values_changed root['revision'] new_value 20250204 old_value 20250202
prod/content-people-pa-v2	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/content-people-v1	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/content-photoslibrary-	values_changed root['revision'] new_value 20250206 old_value 20250130
prod/content-photoslibrary-v1	values_changed root['revision'] new_value 20250206 old_value 20250130
prod/content-preprod-recaptchaenterprise-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/content-preprod-recaptchaenterprise-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/content-preprod-recaptchaenterprise-v1beta1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/content-run-	dictionary_item_added root['schemas']['GoogleDevtoolsCloudbuildV1BuildOptions']['properties']['pubsubTopic'] values_changed root['revision'] new_value 20250131 old_value 20250124 root['schemas']['GoogleCloudRunV2Container']['properties']['baseImageUri']['description'] new_value Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. old_value Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.
prod/content-run-v1	dictionary_item_added root['schemas']['GoogleDevtoolsCloudbuildV1BuildOptions']['properties']['pubsubTopic'] values_changed root['revision'] new_value 20250131 old_value 20250124
prod/content-run-v2	dictionary_item_added root['schemas']['GoogleDevtoolsCloudbuildV1BuildOptions']['properties']['pubsubTopic'] values_changed root['revision'] new_value 20250131 old_value 20250124 root['schemas']['GoogleCloudRunV2Container']['properties']['baseImageUri']['description'] new_value Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. old_value Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.
prod/content-searchconsole-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-searchconsole-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-secretmanager-	values_changed root['revision'] new_value 20250130 old_value 20250117 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://secretmanager.europe-north2.rep.googleapis.com/ location europe-north2
prod/content-secretmanager-v1	values_changed root['revision'] new_value 20250130 old_value 20250117 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://secretmanager.europe-north2.rep.googleapis.com/ location europe-north2
prod/content-secretmanager-v1beta1	values_changed root['revision'] new_value 20250130 old_value 20250117 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://secretmanager.europe-north2.rep.googleapis.com/ location europe-north2
prod/content-secretmanager-v1beta2	values_changed root['revision'] new_value 20250130 old_value 20250117 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://secretmanager.europe-north2.rep.googleapis.com/ location europe-north2
prod/content-servicecontrol-	values_changed root['revision'] new_value 20250131 old_value 20250124
prod/content-servicecontrol-v1	values_changed root['revision'] new_value 20250131 old_value 20250124
prod/content-servicecontrol-v2	values_changed root['revision'] new_value 20250131 old_value 20250124
prod/content-sheets-	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/content-sheets-v1	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/content-sheets-v4	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/content-tagmanager-	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/content-tagmanager-v1	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/content-tagmanager-v2	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/content-testing-	values_changed root['revision'] new_value 20250204 old_value 20250131
prod/content-testing-v1	values_changed root['revision'] new_value 20250204 old_value 20250131
prod/content-videointelligence-	values_changed root['revision'] new_value 20250130 old_value 20241108
prod/content-videointelligence-v1	values_changed root['resources']['operations']['resources']['projects']['resources']['locations']['resources']['operations']['methods']['cancel']['description'] new_value Starts 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_value Starts 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']['cancel']['description'] new_value Starts 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_value Starts 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['revision'] new_value 20250130 old_value 20241108
prod/content-videointelligence-v1beta2	values_changed root['revision'] new_value 20250130 old_value 20241108
prod/content-videointelligence-v1p3beta1	values_changed root['revision'] new_value 20250130 old_value 20241108
prod/content-youtubereporting-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/content-youtubereporting-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/contrails-	dictionary_item_added root['resources']['v1'] values_changed root['revision'] new_value 20250206 old_value 20250204
prod/contrails-v1	dictionary_item_added root['resources']['v1'] values_changed root['revision'] new_value 20250206 old_value 20250204
prod/conversation-v1	values_changed root['revision'] new_value 20250207 old_value 20250128
prod/conversation-v2beta1	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/conversation-v3	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/conversation-v3alpha1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/conversation-v3beta1	values_changed root['revision'] new_value 20250207 old_value 20250128
prod/customsearch-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/customsearch-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/dataflow-	dictionary_item_added root['schemas']['TemplateMetadata']['properties']['yamlDefinition'] values_changed root['revision'] new_value 20250131 old_value 20250125 iterable_item_added root['schemas']['SDKInfo']['properties']['language']['enum'][4] YAML root['schemas']['SDKInfo']['properties']['language']['enumDescriptions'][4] YAML.
prod/dataflow-v1b3	dictionary_item_added root['schemas']['TemplateMetadata']['properties']['yamlDefinition'] values_changed root['revision'] new_value 20250131 old_value 20250125 iterable_item_added root['schemas']['SDKInfo']['properties']['language']['enum'][4] YAML root['schemas']['SDKInfo']['properties']['language']['enumDescriptions'][4] YAML.
prod/dataform-	dictionary_item_added root['schemas']['CodeCompilationConfig']['properties']['defaultNotebookRuntimeOptions']['description'] root['schemas']['Notebook']['description'] root['schemas']['NotebookRuntimeOptions']['description'] root['schemas']['ScheduledExecutionRecord']['properties']['executionTime']['readOnly'] root['schemas']['ScheduledReleaseRecord']['properties']['releaseTime']['readOnly'] root['schemas']['UncommittedFileChange']['properties']['state']['readOnly'] values_changed root['resources']['projects']['resources']['locations']['resources']['repositories']['methods']['delete']['parameters']['force']['description'] new_value Optional. If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.) old_value If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.) root['revision'] new_value 20250202 old_value 20250119 root['schemas']['CommitRepositoryChangesRequest']['properties']['fileOperations']['description'] new_value Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root. old_value A map to the path of the file to the operation. The path is the full file path including filename, from repository root. root['schemas']['DataEncryptionState']['properties']['kmsKeyVersionName']['description'] new_value Required. The KMS key version name with which data of a resource is encrypted. old_value The KMS key version name with which data of a resource is encrypted. root['schemas']['ScheduledExecutionRecord']['properties']['executionTime']['description'] new_value Output only. The timestamp of this execution attempt. old_value The timestamp of this execution attempt. root['schemas']['ScheduledReleaseRecord']['properties']['releaseTime']['description'] new_value Output only. The timestamp of this release attempt. old_value The timestamp of this release attempt. root['schemas']['Target']['properties']['database']['description'] new_value Optional. The action's database (Google Cloud project ID) . old_value The action's database (Google Cloud project ID) . root['schemas']['Target']['properties']['name']['description'] new_value Optional. The action's name, within `database` and `schema`. old_value The action's name, within `database` and `schema`. root['schemas']['Target']['properties']['schema']['description'] new_value Optional. The action's schema (BigQuery dataset ID), within `database`. old_value The action's schema (BigQuery dataset ID), within `database`. root['schemas']['UncommittedFileChange']['properties']['state']['description'] new_value Output only. Indicates the status of the file. old_value Indicates the status of the file.
prod/dataportability-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/dataportability-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/dataportability-v1alpha	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/dataportability-v1beta	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/dataprocrm-	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/datastore-	values_changed root['revision'] new_value 20250204 old_value 20250120 root['schemas']['RunQueryResponse']['properties']['batch']['description'] new_value A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false. old_value A batch of query results (always present).
prod/datastore-v1	values_changed root['revision'] new_value 20250204 old_value 20250120 root['schemas']['RunQueryResponse']['properties']['batch']['description'] new_value A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false. old_value A batch of query results (always present).
prod/datastore-v1beta1	values_changed root['revision'] new_value 20250204 old_value 20250120
prod/datastore-v1beta3	values_changed root['revision'] new_value 20250204 old_value 20250120 root['schemas']['RunQueryResponse']['properties']['batch']['description'] new_value A batch of query results. This is always present unless running a query under explain-only mode: RunQueryRequest.explain_options was provided and ExplainOptions.analyze was set to false. old_value A batch of query results (always present).
prod/delaware-pa-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/delaware-pa-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/deploymentmanager-	values_changed root['revision'] new_value 20250124 old_value 20250130
prod/deploymentmanager-dogfood	values_changed root['revision'] new_value 20250130 old_value 20250124
prod/dialogflow-v1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/dialogflow-v2beta1	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/dialogflow-v3	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/discoveryengine-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/discoveryengine-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/discoveryengine-v1alpha	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/discoveryengine-v1beta	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/displayvideo-v2	values_changed root['revision'] new_value 20250205 old_value 20250129 iterable_item_removed root['schemas']['CustomBiddingAlgorithm']['properties']['customBiddingAlgorithmType']['enum'][2] ADS_DATA_HUB_BASED root['schemas']['CustomBiddingAlgorithm']['properties']['customBiddingAlgorithmType']['enum'][3] GOAL_BUILDER_BASED root['schemas']['CustomBiddingAlgorithm']['properties']['customBiddingAlgorithmType']['enumDescriptions'][2] Algorithm created through Ads Data Hub product. root['schemas']['CustomBiddingAlgorithm']['properties']['customBiddingAlgorithmType']['enumDescriptions'][3] Algorithm created through goal builder in DV3 UI.
prod/dlp-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/dlp-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/dlp-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/driveactivity-	values_changed root['revision'] new_value 20250204 old_value 20250201
prod/driveactivity-v2	values_changed root['revision'] new_value 20250204 old_value 20250201
prod/earthengine-	values_changed root['revision'] new_value 20250203 old_value 20250205
prod/earthengine-highvolume-	values_changed root['revision'] new_value 20250203 old_value 20250205
prod/earthengine-highvolume-v1	values_changed root['revision'] new_value 20250203 old_value 20250205
prod/earthengine-highvolume-v1alpha	values_changed root['revision'] new_value 20250203 old_value 20250205
prod/earthengine-highvolume-v1beta	values_changed root['revision'] new_value 20250203 old_value 20250205
prod/earthengine-v1	values_changed root['revision'] new_value 20250203 old_value 20250205
prod/earthengine-v1alpha	values_changed root['revision'] new_value 20250203 old_value 20250205
prod/echolocal-c2p-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/echolocal-c2p-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/edgecert.us-west2-storage-v1	values_changed root['etag'] new_value "3132323035393438303837343536383433303831" old_value "34303631353734333531353837393630383333" root['revision'] new_value 20250205 old_value 20250201
prod/edgecontainer-v1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://edgecontainer.googleapis.com/ batchPath batch canonicalName Edge Container description discoveryVersion v1 documentationLink https://cloud.google.com/edge-cloud fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id edgecontainer:v1 kind discovery#restDescription mtlsRootUrl https://edgecontainer.mtls.googleapis.com/ name edgecontainer ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations methods get description Gets information about a location. flatPath v1/projects/{projectsId}/locations/{locationsId} httpMethod GET id edgecontainer.projects.locations.get parameterOrder name parameters name description Resource name for the location. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+name} response $ref Location scopes https://www.googleapis.com/auth/cloud-platform getServerConfig description Gets the server config. flatPath v1/projects/{projectsId}/locations/{locationsId}/serverConfig httpMethod GET id edgecontainer.projects.locations.getServerConfig parameterOrder name parameters name description Required. The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+name}/serverConfig response $ref ServerConfig scopes https://www.googleapis.com/auth/cloud-platform list description Lists information about the supported locations for this service. flatPath v1/projects/{projectsId}/locations httpMethod GET id edgecontainer.projects.locations.list parameterOrder name parameters filter description A 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). location query type string name description The resource that owns the locations collection, if applicable. location path pattern ^projects/[^/]+$ required True type string pageSize description The maximum number of results to return. If not set, the service selects a default. format int32 location query type integer pageToken description A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. location query type string path v1/{+name}/locations response $ref ListLocationsResponse scopes https://www.googleapis.com/auth/cloud-platform resources clusters methods create description Creates a new Cluster in a given project and location. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters httpMethod POST id edgecontainer.projects.locations.clusters.create parameterOrder parent parameters clusterId description Required. A client-specified unique identifier for the cluster. location query type string parent description Required. The parent location where this cluster will be created. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string requestId description A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if `request_id` is provided. location query type string path v1/{+parent}/clusters request $ref Cluster response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Cluster. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId} httpMethod DELETE id edgecontainer.projects.locations.clusters.delete parameterOrder name parameters name description Required. The resource name of the cluster. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string requestId description A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if `request_id` is provided. location query type string path v1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform generateAccessToken description Generates an access token for a Cluster. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:generateAccessToken httpMethod GET id edgecontainer.projects.locations.clusters.generateAccessToken parameterOrder cluster parameters cluster description Required. The resource name of the cluster. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1/{+cluster}:generateAccessToken response $ref GenerateAccessTokenResponse scopes https://www.googleapis.com/auth/cloud-platform generateOfflineCredential description Generates an offline credential for a Cluster. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:generateOfflineCredential httpMethod GET id edgecontainer.projects.locations.clusters.generateOfflineCredential parameterOrder cluster parameters cluster description Required. The resource name of the cluster. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1/{+cluster}:generateOfflineCredential response $ref GenerateOfflineCredentialResponse scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Cluster. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId} httpMethod GET id edgecontainer.projects.locations.clusters.get parameterOrder name parameters name description Required. The resource name of the cluster. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1/{+name} response $ref Cluster scopes https://www.googleapis.com/auth/cloud-platform list description Lists Clusters in a given project and location. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters httpMethod GET id edgecontainer.projects.locations.clusters.list parameterOrder parent parameters filter description Only resources matching this filter will be listed. location query type string orderBy description Specifies the order in which resources will be listed. location query type string pageSize description The maximum number of resources to list. format int32 location query type integer pageToken description A page token received from previous list request. A page token received from previous list request. location query type string parent description Required. The parent location, which owns this collection of clusters. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+parent}/clusters response $ref ListClustersResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Cluster. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId} httpMethod PATCH id edgecontainer.projects.locations.clusters.patch parameterOrder name parameters name description Required. The resource name of the cluster. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string requestId description A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if `request_id` is provided. location query type string updateMask description Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1/{+name} request $ref Cluster response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform upgrade description Upgrades a single cluster. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:upgrade httpMethod POST id edgecontainer.projects.locations.clusters.upgrade parameterOrder name parameters name description Required. The resource name of the cluster. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1/{+name}:upgrade request $ref UpgradeClusterRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform resources nodePools methods create description Creates a new NodePool in a given project and location. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools httpMethod POST id edgecontainer.projects.locations.clusters.nodePools.create parameterOrder parent parameters nodePoolId description Required. A client-specified unique identifier for the node pool. location query type string parent description Required. The parent cluster where this node pool will be created. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string requestId description A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if `request_id` is provided. location query type string path v1/{+parent}/nodePools request $ref NodePool response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single NodePool. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId} httpMethod DELETE id edgecontainer.projects.locations.clusters.nodePools.delete parameterOrder name parameters name description Required. The resource name of the node pool. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$ required True type string requestId description A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if `request_id` is provided. location query type string path v1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single NodePool. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId} httpMethod GET id edgecontainer.projects.locations.clusters.nodePools.get parameterOrder name parameters name description Required. The resource name of the node pool. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$ required True type string path v1/{+name} response $ref NodePool scopes https://www.googleapis.com/auth/cloud-platform list description Lists NodePools in a given project and location. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools httpMethod GET id edgecontainer.projects.locations.clusters.nodePools.list parameterOrder parent parameters filter description Only resources matching this filter will be listed. location query type string orderBy description Specifies the order in which resources will be listed. location query type string pageSize description The maximum number of resources to list. format int32 location query type integer pageToken description A page token received from previous list request. location query type string parent description Required. The parent cluster, which owns this collection of node pools. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1/{+parent}/nodePools response $ref ListNodePoolsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single NodePool. flatPath v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId} httpMethod PATCH id edgecontainer.projects.locations.clusters.nodePools.patch parameterOrder name parameters name description Required. The resource name of the node pool. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$ required True type string requestId description A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if `request_id` is provided. location query type string updateMask description Field mask is used to specify the fields to be overwritten in the NodePool resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1/{+name} request $ref NodePool response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform machines methods get description Gets details of a single Machine. flatPath v1/projects/{projectsId}/locations/{locationsId}/machines/{machinesId} httpMethod GET id edgecontainer.projects.locations.machines.get parameterOrder name parameters name description Required. The resource name of the machine. location path pattern ^projects/[^/]+/locations/[^/]+/machines/[^/]+$ required True type string path v1/{+name} response $ref Machine scopes https://www.googleapis.com/auth/cloud-platform list description Lists Machines in a given project and location. flatPath v1/projects/{projectsId}/locations/{locationsId}/machines httpMethod GET id edgecontainer.projects.locations.machines.list parameterOrder parent parameters filter description Only resources matching this filter will be listed. location query type string orderBy description Specifies the order in which resources will be listed. location query type string pageSize description The maximum number of resources to list. format int32 location query type integer pageToken description A page token received from previous list request. location query type string parent description Required. The parent site, which owns this collection of machines. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+parent}/machines response $ref ListMachinesResponse scopes https://www.googleapis.com/auth/cloud-platform operations methods cancel description Starts 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`. flatPath v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel httpMethod POST id edgecontainer.projects.locations.operations.cancel parameterOrder name parameters name description The name of the operation resource to be cancelled. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1/{+name}:cancel request $ref CancelOperationRequest response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes 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`. flatPath v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod DELETE id edgecontainer.projects.locations.operations.delete parameterOrder name parameters name description The name of the operation resource to be deleted. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets 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. flatPath v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id edgecontainer.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. flatPath v1/projects/{projectsId}/locations/{locationsId}/operations httpMethod GET id edgecontainer.projects.locations.operations.list parameterOrder name parameters filter description The standard list filter. location query type string name description The name of the operation's parent resource. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string pageSize description The standard list page size. format int32 location query type integer pageToken description The standard list page token. location query type string path v1/{+name}/operations response $ref ListOperationsResponse scopes https://www.googleapis.com/auth/cloud-platform vpnConnections methods create description Creates a new VPN connection in a given project and location. flatPath v1/projects/{projectsId}/locations/{locationsId}/vpnConnections httpMethod POST id edgecontainer.projects.locations.vpnConnections.create parameterOrder parent parameters parent description Required. The parent location where this vpn connection will be created. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string requestId description A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if `request_id` is provided. location query type string vpnConnectionId description Required. The VPN connection identifier. location query type string path v1/{+parent}/vpnConnections request $ref VpnConnection response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single VPN connection. flatPath v1/projects/{projectsId}/locations/{locationsId}/vpnConnections/{vpnConnectionsId} httpMethod DELETE id edgecontainer.projects.locations.vpnConnections.delete parameterOrder name parameters name description Required. The resource name of the vpn connection. location path pattern ^projects/[^/]+/locations/[^/]+/vpnConnections/[^/]+$ required True type string requestId description A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if `request_id` is provided. location query type string path v1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single VPN connection. flatPath v1/projects/{projectsId}/locations/{locationsId}/vpnConnections/{vpnConnectionsId} httpMethod GET id edgecontainer.projects.locations.vpnConnections.get parameterOrder name parameters name description Required. The resource name of the vpn connection. location path pattern ^projects/[^/]+/locations/[^/]+/vpnConnections/[^/]+$ required True type string path v1/{+name} response $ref VpnConnection scopes https://www.googleapis.com/auth/cloud-platform list description Lists VPN connections in a given project and location. flatPath v1/projects/{projectsId}/locations/{locationsId}/vpnConnections httpMethod GET id edgecontainer.projects.locations.vpnConnections.list parameterOrder parent parameters filter description Only resources matching this filter will be listed. location query type string orderBy description Specifies the order in which resources will be listed. location query type string pageSize description The maximum number of resources to list. format int32 location query type integer pageToken description A page token received from previous list request. location query type string parent description Required. The parent location, which owns this collection of VPN connections. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+parent}/vpnConnections response $ref ListVpnConnectionsResponse scopes https://www.googleapis.com/auth/cloud-platform revision 20250122 rootUrl https://edgecontainer.googleapis.com/ schemas Authorization description RBAC policy that will be applied and managed by GEC. id Authorization properties adminUsers $ref ClusterUser description Required. User that will be granted the cluster-admin role on the cluster, providing full access to the cluster. Currently, this is a singular field, but will be expanded to allow multiple admins in the future. type object CancelOperationRequest description The request message for Operations.CancelOperation. id CancelOperationRequest properties type object ChannelConfig description Configuration for a release channel. id ChannelConfig properties defaultVersion description Output only. Default version for this release channel, e.g.: "1.4.0". readOnly True type string type object CloudRouter description The Cloud Router info. id CloudRouter properties name description The associated Cloud Router name. type string type object CloudVpn description The Cloud VPN info. id CloudVpn properties gateway description The created Cloud VPN gateway name. type string type object Cluster description A Google Distributed Cloud Edge Kubernetes cluster. id Cluster properties authorization $ref Authorization description Required. Immutable. RBAC policy that will be applied and managed by GEC. clusterCaCertificate description Output only. The PEM-encoded public certificate of the cluster's CA. readOnly True type string connectionState $ref ConnectionState description Output only. The current connection state of the cluster. readOnly True containerRuntimeConfig $ref ContainerRuntimeConfig description Optional. The container runtime config of the cluster. controlPlane $ref ControlPlane description Optional. The configuration of the cluster control plane. controlPlaneEncryption $ref ControlPlaneEncryption description Optional. Remote control plane disk encryption options. This field is only used when enabling CMEK support. controlPlaneVersion description Output only. The control plane release version readOnly True type string createTime description Output only. The time when the cluster was created. format google-datetime readOnly True type string defaultMaxPodsPerNode description Optional. The default maximum number of pods per node used if a maximum value is not specified explicitly for a node pool in this cluster. If unspecified, the Kubernetes default value will be used. format int32 type integer endpoint description Output only. The IP address of the Kubernetes API server. readOnly True type string externalLoadBalancerAddressPools description Optional. External load balancer pools for cluster. items $ref ExternalLoadBalancerPool type array externalLoadBalancerIpv4AddressPools description Optional. IPv4 address pools for cluster data plane external load balancing. items type string type array externalLoadBalancerIpv6AddressPools description Optional. IPv6 address pools for cluster data plane external load balancing. items type string type array fleet $ref Fleet description Required. Fleet configuration. labels additionalProperties type string description Labels associated with this resource. type object maintenanceEvents description Output only. All the maintenance events scheduled for the cluster, including the ones ongoing, planned for the future and done in the past (up to 90 days). items $ref MaintenanceEvent readOnly True type array maintenancePolicy $ref MaintenancePolicy description Optional. Cluster-wide maintenance policy configuration. name description Required. The resource name of the cluster. type string networking $ref ClusterNetworking description Required. Cluster-wide networking configuration. nodeVersion description Output only. The lowest release version among all worker nodes. This field can be empty if the cluster does not have any worker nodes. readOnly True type string port description Output only. The port number of the Kubernetes API server. format int32 readOnly True type integer releaseChannel description Optional. The release channel a cluster is subscribed to. enum RELEASE_CHANNEL_UNSPECIFIED NONE REGULAR enumDescriptions Unspecified release channel. This will default to the REGULAR channel. No release channel. Regular release channel. type string status description Output only. The current status of the cluster. enum STATUS_UNSPECIFIED PROVISIONING RUNNING DELETING ERROR RECONCILING enumDescriptions Status unknown. The cluster is being created. The cluster is created and fully usable. The cluster is being deleted. The status indicates that some errors occurred while reconciling/deleting the cluster. The cluster is undergoing some work such as version upgrades, etc. readOnly True type string survivabilityConfig $ref SurvivabilityConfig description Optional. Configuration of the cluster survivability, e.g., for the case when network connectivity is lost. Note: This only applies to local control plane clusters. systemAddonsConfig $ref SystemAddonsConfig description Optional. The configuration of the system add-ons. targetVersion description Optional. The target cluster version. For example: "1.5.0". type string updateTime description Output only. The time when the cluster was last updated. format google-datetime readOnly True type string zoneStorageEncryption $ref ZoneStorageEncryption description Optional. The zone storage encryption configuration type object ClusterNetworking description Cluster-wide networking configuration. id ClusterNetworking properties clusterIpv4CidrBlocks description Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these blocks. Only a single block is supported. This field cannot be changed after creation. items type string type array servicesIpv4CidrBlocks description Required. All services in the cluster are assigned an RFC1918 IPv4 address from these blocks. Only a single block is supported. This field cannot be changed after creation. items type string type array type object ClusterUser description A user principal for an RBAC policy. id ClusterUser properties username description Required. An active Google username. type string type object ConfigData description Config data holds all the config related data for the zone. id ConfigData properties availableExternalLbPoolsIpv4 description list of available v4 ip pools for external loadbalancer items type string type array availableExternalLbPoolsIpv6 description list of available v6 ip pools for external loadbalancer items type string type array type object ConnectionState description ConnectionState holds the current connection state from the cluster to Google. id ConnectionState properties state description Output only. The current connection state. enum STATE_UNSPECIFIED DISCONNECTED CONNECTED CONNECTED_AND_SYNCING enumDescriptions Unknown connection state. This cluster is currently disconnected from Google. This cluster is currently connected to Google. This cluster is currently connected to Google, but may have recently reconnected after a disconnection. It is still syncing back. readOnly True type string updateTime description Output only. The time when the connection state was last changed. format google-datetime readOnly True type string type object ContainerRuntimeConfig description Container runtime config of the cluster. id ContainerRuntimeConfig properties defaultContainerRuntime description Optional. The default container runtime to be configured in the cluster. enum DEFAULT_CONTAINER_RUNTIME_UNSPECIFIED RUNC GVISOR enumDescriptions Container runtime not specified. Use runc as the default container runtime in the cluster. Use gVisor as the default container runtime in the cluster. type string type object ControlPlane description Configuration of the cluster control plane. id ControlPlane properties local $ref Local description Local control plane configuration. Warning: Local control plane clusters must be created in their own project. Local control plane clusters cannot coexist in the same project with any other type of clusters, including non-GDCE clusters. Mixing local control plane GDCE clusters with any other type of clusters in the same project can result in data loss. remote $ref Remote description Remote control plane configuration. type object ControlPlaneEncryption description Configuration for Customer-managed KMS key support for control plane nodes. id ControlPlaneEncryption properties kmsKey description Optional. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting control plane disks. If not specified, a Google-managed key will be used instead. type string kmsKeyActiveVersion description Output only. The Cloud KMS CryptoKeyVersion currently in use for protecting control plane disks. Only applicable if kms_key is set. readOnly True type string kmsKeyState description Output only. Availability of the Cloud KMS CryptoKey. If not `KEY_AVAILABLE`, then nodes may go offline as they cannot access their local data. This can be caused by a lack of permissions to use the key, or if the key is disabled or deleted. enum KMS_KEY_STATE_UNSPECIFIED KMS_KEY_STATE_KEY_AVAILABLE KMS_KEY_STATE_KEY_UNAVAILABLE enumDescriptions Unspecified. The key is available for use, and dependent resources should be accessible. The key is unavailable for an unspecified reason. Dependent resources may be inaccessible. readOnly True type string kmsStatus $ref Status description Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if `kms_key_state` is not `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the error status reported by Cloud KMS. readOnly True resourceState description Output only. The current resource state associated with the cmek. enum RESOURCE_STATE_UNSPECIFIED RESOURCE_STATE_LOCK_DOWN RESOURCE_STATE_LOCK_DOWN_PENDING enumDescriptions Default value. The resource is in LOCK DOWN state. The resource is pending lock down. readOnly True type string type object Details description The created connection details. id Details properties cloudRouter $ref CloudRouter description The Cloud Router info. cloudVpns description Each connection has multiple Cloud VPN gateways. items $ref CloudVpn type array error description The error message. This is only populated when state=ERROR. type string state description The state of this connection. enum STATE_UNSPECIFIED STATE_CONNECTED STATE_CONNECTING STATE_ERROR enumDescriptions Unknown. Connected. Still connecting. Error occurred. type string type object Empty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id Empty properties type object ExternalLoadBalancerPool description External load balancer pool with custom config such as name, manual/auto assign, non-overlapping ipv4 and optional ipv6 address range. id ExternalLoadBalancerPool properties addressPool description Optional. Name of the external load balancer pool. type string avoidBuggyIps description Optional. If true, the pool omits IP addresses ending in .0 and .255. Some network hardware drops traffic to these special addresses. Its default value is false. type boolean ipv4Range description Required. Non-overlapping IPv4 address range of the external load balancer pool. items type string type array ipv6Range description Optional. Non-overlapping IPv6 address range of the external load balancer pool. items type string type array manualAssign description Optional. If true, addresses in this pool are not automatically assigned to Kubernetes Services. If true, an IP address in this pool is used only when it is specified explicitly by a service. Its default value is false. type boolean type object Fleet description Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. id Fleet properties membership description Output only. The name of the managed Hub Membership resource associated to this cluster. Membership names are formatted as `projects//locations/global/membership/`. readOnly True type string project description Required. The name of the Fleet host project where this cluster will be registered. Project names are formatted as `projects/`. type string type object GenerateAccessTokenResponse description An access token for a cluster. id GenerateAccessTokenResponse properties accessToken description Output only. Access token to authenticate to k8s api-server. readOnly True type string expireTime description Output only. Timestamp at which the token will expire. format google-datetime readOnly True type string type object GenerateOfflineCredentialResponse description An offline credential for a cluster. id GenerateOfflineCredentialResponse properties clientCertificate description Output only. Client certificate to authenticate to k8s api-server. readOnly True type string clientKey description Output only. Client private key to authenticate to k8s api-server. readOnly True type string expireTime description Output only. Timestamp at which this credential will expire. format google-datetime readOnly True type string userId description Output only. Client's identity. readOnly True type string type object Ingress description Config for the Ingress add-on which allows customers to create an Ingress object to manage external access to the servers in a cluster. The add-on consists of istiod and istio-ingress. id Ingress properties disabled description Optional. Whether Ingress is disabled. type boolean ipv4Vip description Optional. Ingress VIP. type string type object ListClustersResponse description List of clusters in a location. id ListClustersResponse properties clusters description Clusters in the location. items $ref Cluster type array nextPageToken description A token to retrieve next page of results. type string unreachable description Locations that could not be reached. items type string type array type object ListLocationsResponse description The response message for Locations.ListLocations. id ListLocationsResponse properties locations description A list of locations that matches the specified filter in the request. items $ref Location type array nextPageToken description The standard List next-page token. type string type object ListMachinesResponse description List of machines in a site. id ListMachinesResponse properties machines description Machines in the site. items $ref Machine type array nextPageToken description A token to retrieve next page of results. type string unreachable description Locations that could not be reached. items type string type array type object ListNodePoolsResponse description List of node pools in a cluster. id ListNodePoolsResponse properties nextPageToken description A token to retrieve next page of results. type string nodePools description Node pools in the cluster. items $ref NodePool type array unreachable description Locations that could not be reached. items type string type array type object ListOperationsResponse description The response message for Operations.ListOperations. id ListOperationsResponse properties nextPageToken description The standard List next-page token. type string operations description A list of operations that matches the specified filter in the request. items $ref Operation type array type object ListVpnConnectionsResponse description List of VPN connections in a location. id ListVpnConnectionsResponse properties nextPageToken description A token to retrieve next page of results. type string unreachable description Locations that could not be reached. items type string type array vpnConnections description VpnConnections in the location. items $ref VpnConnection type array type object Local description Configuration specific to clusters with a control plane hosted locally. Warning: Local control plane clusters must be created in their own project. Local control plane clusters cannot coexist in the same project with any other type of clusters, including non-GDCE clusters. Mixing local control plane GDCE clusters with any other type of clusters in the same project can result in data loss. id Local properties controlPlaneNodeStorageSchema description Optional. Name for the storage schema of control plane nodes. Warning: Configurable node local storage schema feature is an experimental feature, and is not recommended for general use in production clusters/nodepools. type string machineFilter description Only machines matching this filter will be allowed to host control plane nodes. The filtering language accepts strings like "name=", and is documented here: [AIP-160](https://google.aip.dev/160). type string nodeCount description The number of nodes to serve as replicas of the Control Plane. format int32 type integer nodeLocation description Name of the Google Distributed Cloud Edge zones where this node pool will be created. For example: `us-central1-edge-customer-a`. type string sharedDeploymentPolicy description Policy configuration about how user applications are deployed. enum SHARED_DEPLOYMENT_POLICY_UNSPECIFIED ALLOWED DISALLOWED enumDescriptions Unspecified. User applications can be deployed both on control plane and worker nodes. User applications can not be deployed on control plane nodes and can only be deployed on worker nodes. type string type object LocalDiskEncryption description Configuration for CMEK support for edge machine local disk encryption. id LocalDiskEncryption properties kmsKey description Optional. The Cloud KMS CryptoKey e.g. projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} to use for protecting node local disks. If not specified, a Google-managed key will be used instead. type string kmsKeyActiveVersion description Output only. The Cloud KMS CryptoKeyVersion currently in use for protecting node local disks. Only applicable if kms_key is set. readOnly True type string kmsKeyState description Output only. Availability of the Cloud KMS CryptoKey. If not `KEY_AVAILABLE`, then nodes may go offline as they cannot access their local data. This can be caused by a lack of permissions to use the key, or if the key is disabled or deleted. enum KMS_KEY_STATE_UNSPECIFIED KMS_KEY_STATE_KEY_AVAILABLE KMS_KEY_STATE_KEY_UNAVAILABLE enumDescriptions Unspecified. The key is available for use, and dependent resources should be accessible. The key is unavailable for an unspecified reason. Dependent resources may be inaccessible. readOnly True type string kmsStatus $ref Status description Output only. Error status returned by Cloud KMS when using this key. This field may be populated only if `kms_key_state` is not `KMS_KEY_STATE_KEY_AVAILABLE`. If populated, this field contains the error status reported by Cloud KMS. readOnly True resourceState description Output only. The current resource state associated with the cmek. enum RESOURCE_STATE_UNSPECIFIED RESOURCE_STATE_LOCK_DOWN RESOURCE_STATE_LOCK_DOWN_PENDING enumDescriptions Default value. The resource is in LOCK DOWN state. The resource is pending lock down. readOnly True type string type object Location description A resource that represents a Google Cloud location. id Location properties displayName description The friendly name for this location, typically a nearby city name. For example, "Tokyo". type string labels additionalProperties type string description Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} type object locationId description The canonical id for this location. For example: `"us-east1"`. type string metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-specific metadata. For example the available capacity at the given location. type object name description Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` type string type object LocationMetadata description Metadata for a given google.cloud.location.Location. id LocationMetadata properties availableZones additionalProperties $ref ZoneMetadata description The set of available Google Distributed Cloud Edge zones in the location. The map is keyed by the lowercase ID of each zone. type object type object Machine description A Google Distributed Cloud Edge machine capable of acting as a Kubernetes node. id Machine properties createTime description Output only. The time when the node pool was created. format google-datetime readOnly True type string disabled description Output only. Whether the machine is disabled. If disabled, the machine is unable to enter service. readOnly True type boolean hostedNode description Canonical resource name of the node that this machine is responsible for hosting e.g. projects/{project}/locations/{location}/clusters/{cluster_id}/nodePools/{pool_id}/{node}, Or empty if the machine is not assigned to assume the role of a node. For control plane nodes hosted on edge machines, this will return the following format: "projects/{project}/locations/{location}/clusters/{cluster_id}/controlPlaneNodes/{node}". type string labels additionalProperties type string description Labels associated with this resource. type object name description Required. The resource name of the machine. type string purpose description The type of cluster the machine is used for. enum PURPOSE_UNSPECIFIED VIRTUALIZED_WORKLOAD BAREMETAL_CLUSTER enumDescriptions Unspecified purpose. Machine is used for virtual workload. Machine is used for a baremetal user cluster. type string status description Output only. The current status of the machine. enum STATUS_UNSPECIFIED READY DISABLED_FOR_REPAIR enumDescriptions Status unknown. The machine is ready to host a node. This is the default. The machine has been disabled for repair by adding 1 or more disable claims. readOnly True type string updateTime description Output only. The time when the node pool was last updated. format google-datetime readOnly True type string version description Output only. The software version of the machine. readOnly True type string zone description The Google Distributed Cloud Edge zone of this machine. type string type object MaintenanceEvent description A Maintenance Event is an operation that could cause temporary disruptions to the cluster workloads, including Google-driven or user-initiated cluster upgrades, user-initiated cluster configuration changes that require restarting nodes, etc. id MaintenanceEvent properties createTime description Output only. The time when the maintenance event request was created. format google-datetime readOnly True type string endTime description Output only. The time when the maintenance event ended, either successfully or not. If the maintenance event is split into multiple maintenance windows, end_time is only updated when the whole flow ends. format google-datetime readOnly True type string operation description Output only. The operation for running the maintenance event. Specified in the format projects/*/locations/*/operations/*. If the maintenance event is split into multiple operations (e.g. due to maintenance windows), the latest one is recorded. readOnly True type string schedule description Output only. The schedule of the maintenance event. enum SCHEDULE_UNSPECIFIED IMMEDIATELY enumDescriptions Unspecified. Immediately after receiving the request. readOnly True type string startTime description Output only. The time when the maintenance event started. format google-datetime readOnly True type string state description Output only. The state of the maintenance event. enum STATE_UNSPECIFIED RECONCILING SUCCEEDED FAILED enumDescriptions Unspecified. The maintenance event is ongoing. The cluster might be unusable. The maintenance event succeeded. The maintenance event failed. readOnly True type string targetVersion description Output only. The target version of the cluster. readOnly True type string type description Output only. The type of the maintenance event. enum TYPE_UNSPECIFIED USER_INITIATED_UPGRADE GOOGLE_DRIVEN_UPGRADE enumDescriptions Unspecified. Upgrade initiated by users. Upgrade driven by Google. readOnly True type string updateTime description Output only. The time when the maintenance event message was updated. format google-datetime readOnly True type string uuid description Output only. UUID of the maintenance event. readOnly True type string type object MaintenanceExclusionWindow description Represents a maintenance exclusion window. id MaintenanceExclusionWindow properties id description Optional. A unique (per cluster) id for the window. type string window $ref TimeWindow description Optional. The time window. type object MaintenancePolicy description Maintenance policy configuration. id MaintenancePolicy properties maintenanceExclusions description Optional. Exclusions to automatic maintenance. Non-emergency maintenance should not occur in these windows. Each exclusion has a unique name and may be active or expired. The max number of maintenance exclusions allowed at a given time is 3. items $ref MaintenanceExclusionWindow type array window $ref MaintenanceWindow description Specifies the maintenance window in which maintenance may be performed. type object MaintenanceWindow description Maintenance window configuration id MaintenanceWindow properties recurringWindow $ref RecurringTimeWindow description Configuration of a recurring maintenance window. type object NodeConfig description Configuration for each node in the NodePool id NodeConfig properties labels additionalProperties type string description Optional. The Kubernetes node labels type object nodeStorageSchema description Optional. Name for the storage schema of worker nodes. Warning: Configurable node local storage schema feature is an experimental feature, and is not recommended for general use in production clusters/nodepools. type string type object NodePool description A set of Kubernetes nodes in a cluster with common configuration and specification. id NodePool properties createTime description Output only. The time when the node pool was created. format google-datetime readOnly True type string labels additionalProperties type string description Labels associated with this resource. type object localDiskEncryption $ref LocalDiskEncryption description Optional. Local disk encryption options. This field is only used when enabling CMEK support. machineFilter description Only machines matching this filter will be allowed to join the node pool. The filtering language accepts strings like "name=", and is documented in more detail in [AIP-160](https://google.aip.dev/160). type string name description Required. The resource name of the node pool. type string nodeConfig $ref NodeConfig description Optional. Configuration for each node in the NodePool nodeCount description Required. The number of nodes in the pool. format int32 type integer nodeLocation description Name of the Google Distributed Cloud Edge zone where this node pool will be created. For example: `us-central1-edge-customer-a`. type string nodeVersion description Output only. The lowest release version among all worker nodes. readOnly True type string updateTime description Output only. The time when the node pool was last updated. format google-datetime readOnly True type string type object Operation description This resource represents a long-running operation that is the result of a network API call. id Operation properties done description If 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. type boolean error $ref Status description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object OperationMetadata description Long-running operation metadata for Edge Container API methods. id OperationMetadata properties apiVersion description API version used to start the operation. type string createTime description The time the operation was created. format google-datetime type string endTime description The time the operation finished running. format google-datetime type string requestedCancellation description Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. type boolean statusMessage description Human-readable status of the operation, if any. type string statusReason description Machine-readable status of the operation, if any. enum STATUS_REASON_UNSPECIFIED UPGRADE_PAUSED enumDescriptions Reason unknown. The cluster upgrade is currently paused. type string target description Server-defined resource path for the target of the operation. type string verb description The verb executed by the operation. type string warnings description Warnings that do not block the operation, but still hold relevant information for the end user to receive. items type string type array type object Quota description Represents quota for Edge Container resources. id Quota properties limit description Quota limit for this metric. format double type number metric description Name of the quota metric. type string usage description Current usage of this metric. format double type number type object RecurringTimeWindow description Represents an arbitrary window of time that recurs. id RecurringTimeWindow properties recurrence description An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window recurs. They go on for the span of time between the start and end time. type string window $ref TimeWindow description The window of the first recurrence. type object Remote description Configuration specific to clusters with a control plane hosted remotely. id Remote properties type object ServerConfig description Server configuration for supported versions and release channels. id ServerConfig properties channels additionalProperties $ref ChannelConfig description Output only. Mapping from release channel to channel config. readOnly True type object defaultVersion description Output only. Default version, e.g.: "1.4.0". readOnly True type string versions description Output only. Supported versions, e.g.: ["1.4.0", "1.5.0"]. items $ref Version readOnly True type array type object Status description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id Status properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object SurvivabilityConfig description Configuration of the cluster survivability, e.g., for the case when network connectivity is lost. id SurvivabilityConfig properties offlineRebootTtl description Optional. Time period that allows the cluster nodes to be rebooted and become functional without network connectivity to Google. The default 0 means not allowed. The maximum is 7 days. format google-duration type string type object SystemAddonsConfig description Config that customers are allowed to define for GDCE system add-ons. id SystemAddonsConfig properties ingress $ref Ingress description Optional. Config for Ingress. vmServiceConfig $ref VMServiceConfig description Optional. Config for VM Service. type object TimeWindow description Represents an arbitrary window of time. id TimeWindow properties endTime description The time that the window ends. The end time must take place after the start time. format google-datetime type string startTime description The time that the window first starts. format google-datetime type string type object UpgradeClusterRequest description Upgrades a cluster. id UpgradeClusterRequest properties requestId description A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if `request_id` is provided. type string schedule description The schedule for the upgrade. enum SCHEDULE_UNSPECIFIED IMMEDIATELY enumDescriptions Unspecified. The default is to upgrade the cluster immediately which is the only option today. The cluster is going to be upgraded immediately after receiving the request. type string targetVersion description Required. The version the cluster is going to be upgraded to. type string type object VMServiceConfig description VMServiceConfig defines the configuration for GDCE VM Service. id VMServiceConfig properties vmmEnabled description Optional. Whether VMM is enabled. type boolean type object Version description Version of a cluster. id Version properties name description Output only. Name of the version, e.g.: "1.4.0". readOnly True type string type object VpcProject description Project detail of the VPC network. id VpcProject properties projectId description The project of the VPC to connect to. If not specified, it is the same as the cluster project. type string serviceAccount deprecated True description Optional. Deprecated: do not use. type string type object VpnConnection description A VPN connection . id VpnConnection properties bgpRoutingMode deprecated True description Dynamic routing mode of the VPC network, `regional` or `global`. enum BGP_ROUTING_MODE_UNSPECIFIED REGIONAL GLOBAL enumDescriptions Unknown. Regional mode. Global mode. type string cluster description The canonical Cluster name to connect to. It is in the form of projects/{project}/locations/{location}/clusters/{cluster}. type string createTime description Output only. The time when the VPN connection was created. format google-datetime readOnly True type string details $ref Details description Output only. The created connection details. readOnly True enableHighAvailability description Whether this VPN connection has HA enabled on cluster side. If enabled, when creating VPN connection we will attempt to use 2 ANG floating IPs. type boolean labels additionalProperties type string description Labels associated with this resource. type object name description Required. The resource name of VPN connection type string natGatewayIp description NAT gateway IP, or WAN IP address. If a customer has multiple NAT IPs, the customer needs to configure NAT such that only one external IP maps to the GMEC Anthos cluster. This is empty if NAT is not used. type string router description Optional. The VPN connection Cloud Router name. type string updateTime description Output only. The time when the VPN connection was last updated. format google-datetime readOnly True type string vpc description The network ID of VPC to connect to. type string vpcProject $ref VpcProject description Optional. Project detail of the VPC network. Required if VPC is in a different project than the cluster project. type object ZoneMetadata description A Google Distributed Cloud Edge zone where edge machines are located. id ZoneMetadata properties configData $ref ConfigData description Config data for the zone. quota description Quota for resources in this zone. items $ref Quota type array rackTypes additionalProperties enum RACK_TYPE_UNSPECIFIED BASE EXPANSION enumDescriptions Unspecified rack type, single rack also belongs to this type. Base rack type, a pair of two modified Config-1 racks containing Aggregation switches. Expansion rack type, also known as standalone racks, added by customers on demand. type string description The map keyed by rack name and has value of RackType. type object type object ZoneStorageEncryption description Configuration for Zone Storage CMEK Support id ZoneStorageEncryption properties kmsKey description Optional. The Cloud KMS Key type string kmsKeyActiveVersion description Output only. The Cloud KMS CryptoKeyVersion currently used for encryption/decryption readOnly True type string resourceState description Output only. The current resource state of the CMEK enum RESOURCE_STATE_UNSPECIFIED RESOURCE_STATE_LOCK_DOWN RESOURCE_STATE_LOCK_DOWN_PENDING enumDescriptions Default value. The resource is in LOCK DOWN state. The resource is pending lock down. readOnly True type string type object servicePath title Distributed Cloud Edge Container API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/embeddedassistant-	values_changed root new_value basePath baseUrl https://embeddedassistant.googleapis.com/ batchPath batch canonicalName Embedded Assistant description Google Assistant API discoveryVersion v1 documentationLink https://developers.google.com/assistant/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id embeddedassistant:v1beta1 kind discovery#restDescription mtlsRootUrl https://embeddedassistant.mtls.googleapis.com/ name embeddedassistant ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources deviceModels methods create description Creates a device model. flatPath v1beta1/projects/{projectsId}/deviceModels httpMethod POST id embeddedassistant.projects.deviceModels.create parameterOrder parent parameters parent description Name of the project with the form: `projects/{project_id}`. location path pattern ^projects/[^/]+$ required True type string path v1beta1/{+parent}/deviceModels request $ref DeviceModel response $ref DeviceModel delete description Deletes a device model. flatPath v1beta1/projects/{projectsId}/deviceModels/{deviceModelsId} httpMethod DELETE id embeddedassistant.projects.deviceModels.delete parameterOrder name parameters name description Name of the device model with the form: `projects/{project_id}/deviceModels/{device_model_id}`. location path pattern ^projects/[^/]+/deviceModels/[^/]+$ required True type string path v1beta1/{+name} response $ref DeleteDeviceModelResponse get description Returns the device model with the given ID. flatPath v1beta1/projects/{projectsId}/deviceModels/{deviceModelsId} httpMethod GET id embeddedassistant.projects.deviceModels.get parameterOrder name parameters name description Name of the device model with the form: `projects/{project_id}/deviceModels/{device_model_id}`. location path pattern ^projects/[^/]+/deviceModels/[^/]+$ required True type string path v1beta1/{+name} response $ref DeviceModel list description Lists all of the device models for the given project ID. Limit: 1,000 results. flatPath v1beta1/projects/{projectsId}/deviceModels httpMethod GET id embeddedassistant.projects.deviceModels.list parameterOrder parent parameters parent description Name of the project with the form: `projects/{project_ID}`. location path pattern ^projects/[^/]+$ required True type string path v1beta1/{+parent}/deviceModels response $ref ListDeviceModelsResponse update description Updates a device model. `Note:` this overwrites the DeviceModel content, so the request should contain the entire DeviceModel. flatPath v1beta1/projects/{projectsId}/deviceModels/{deviceModelsId} httpMethod PUT id embeddedassistant.projects.deviceModels.update parameterOrder name parameters name description Name of the device model with the form: `projects/{project_id}/deviceModels/{device_model_id}`. location path pattern ^projects/[^/]+/deviceModels/[^/]+$ required True type string path v1beta1/{+name} request $ref DeviceModel response $ref DeviceModel revision 20250206 rootUrl https://embeddedassistant.googleapis.com/ schemas AlarmCapability description Capability with regard to support of alarms by the client. id AlarmCapability properties maxSupportedAlarms description Maximum number of alarms that can be created on the client. Zero or unset indicates no maximum limit. format int32 type integer restrictAlarmsToNextDay description Whether the client restricts alarms to ring within the next 24 hours. type boolean type object App description Configuration for an available app. Defines a unique key for the app along with multiple user-friendly names. id App properties key description A canonicalized identifier for the app. type string names description List of nicknames for a specific app, e.g., "Google" or "Google App". items type string type array type object AppSettingCapability description Configures the UI for SDK devices on the Assistant App. For example, you can change: language, notification, and input/output methods. id AppSettingCapability properties disableLanguageDisplay description If set, the device won't show its supported query language on the Assistant App. If not set, the language shown on the Assistant App will override the client's language when applicable. To enable this, devices must provide an interface for the user to set the language. type boolean type object ArgSpec description Argument associated with an Intent. id ArgSpec properties intValueSpec $ref IntValueSpec optionValueSpec $ref OptionValueSpec type enum TYPE_UNSPECIFIED BOOL INTEGER OPTION enumDescriptions A type must be specified. The arg value type is boolean. The arg value type is integer. The value can be any integer unless IntValueSpec is provided. The arg value is from list of options. The valid options are specified from OptionValueSpec. type string type object AvailableApps description A universal set of available apps provided for app understanding. id AvailableApps properties disableGoogleApps description To prevent Google's catalog of apps from being enabled by default, then set `disableGoogleApps` to `true` in the device model. type boolean localizedApps description List of apps which should be enabled. items $ref LocalizedApps type array type object AvailableChannels description A universal set of available channels provided for channel understanding. id AvailableChannels properties disableGoogleChannels description To prevent Google's catalog of channels from being enabled by default, then set `disableGoogleChannels` to `true` in the device model. type boolean localizedChannels items $ref LocalizedChannels type array type object Channel description Configuration for an available channel. Defines a unique key for the channel along with multiple user-friendly names. id Channel properties key type string names description List of nicknames for a specific channel, e.g., "NTGEO" or "National Geographic" or "Nat Geo". items type string type array number description The channel number as viewed by user. This field is not an exclusive field to key/names. type string type object CloudCapability description Lists which cloud endpoint(s) to use for cloud execution of actions or registration. id CloudCapability properties cloudEndpoints description The list of CloudEndpoints supported by this Device Model. Each endpoint should have a unique `name`. If any cloud endpoints are provided here, then the first one in the list will be used by default for all Cloud Execution. An Intent may override the default by providing an `execution_config`. items $ref CloudEndpoint type array type object CloudEndpoint description A cloud endpoint associated with this device, which may be invoked for query parsing or cloud execution. id CloudEndpoint properties name description The name for this cloud endpoint. It must be unique within a Device Model. Ex: "sample-nlu-endpoint" type string scopes description The list of scopes to be provided in the OAuth2 token. They must be a subset of the scopes registered in the Account Linking flow, or the request will fail. If the client itself provides the token, then this field is ignored. items type string type array url description The URL for this endpoint. It must start with "https". type string type object DeleteDeviceModelResponse description Response message for DevicesPlatformExternalService.DeleteDeviceModel. id DeleteDeviceModelResponse properties type object DeviceActionCapabilities description Represents device action capabilities. id DeviceActionCapabilities properties builtInIntentMode description Specifies behavior for built-in device actions for this device model. If not specified, defaults to ENABLE_CONFIGURED_INTENTS_ONLY. enum CUSTOM_INTENT_CAPABILITY_UNSPECIFIED ENABLE_ALL ENABLE_ALL_AUTO_ACTIONS ENABLE_CONFIGURED_INTENTS_ONLY PUNT_FOR_UNCONFIGURED_INTENTS enumDescriptions All intents are enabled, regardless of whether the intent is registered in the `intents` field. All Auto device actions are enabled, regardless of whether the intent is registered in the `intents` field. Only use it for Auto device type. Only the intents registered in the `intents` field will be enabled. Only the intents registered in the `intents` field will be enabled. Additionally, read an error message when the unconfigured intents are invoked. type string customIntentMode description Specifies which custom device actions should be enabled for this device model. This will only affect the behavior of intents corresponding to those from the Action Package of this project. If not specified, defaults to ENABLE_ALL. enum CUSTOM_INTENT_CAPABILITY_UNSPECIFIED ENABLE_ALL ENABLE_ALL_AUTO_ACTIONS ENABLE_CONFIGURED_INTENTS_ONLY PUNT_FOR_UNCONFIGURED_INTENTS enumDescriptions All intents are enabled, regardless of whether the intent is registered in the `intents` field. All Auto device actions are enabled, regardless of whether the intent is registered in the `intents` field. Only use it for Auto device type. Only the intents registered in the `intents` field will be enabled. Only the intents registered in the `intents` field will be enabled. Additionally, read an error message when the unconfigured intents are invoked. type string defaultExecutionConfig $ref ExecutionConfig description Default instructions for routing intents. If you want to override this setting for specific intents, provide the new data in the `intents` field. inlinedActionCapability $ref InlinedActionCapability description Specifies capabilities for device actions that are inlined in the DeviceAction message in the response. intents description Intent configurations: built-in and custom intents can be configured here. Built-in intents will always behave with IntentMode of `ENABLE_CONFIGURED_INTENTS_ONLY`. The IntentMode for custom intents can be changed using the `custom_intent_mode`. To configure an intent, list it here with its intent name. For example: "MY_CUSTOM_INTENT", "google.assistant.car.model.capabilities.AC_TEMPERATURE". items $ref Intent type array providedData description Provided data which augments the device action capabilities. Some built-in intents may require additional configuration to be provided. One example could be the list of channels available for the SelectChannel intent. For more details on what provided_data is available, see the individual intent documentations. # JSON The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: { "@type": "type.googleapis.com/google.assistant.devices.v1beta1.intent.AvailableChannels", "localizedChannels": [{ "locale": , "channels": [{ "key": , "names": [, ... ] }] }] } items $ref ProvidedData type array traits deprecated True description List of built-in traits the device can support. For example, "action.devices.traits.OnOff". Deprecated, traits should be registered as intents. items type string type array type object DeviceModel description Defines metadata and common capabilities for a family of devices. id DeviceModel properties capabilities $ref DeviceModelCapabilities description Optional. Describes the capabilities of the Device Model. clientId description Auth client ID that is created for this device model. type string deviceModelId description Required. Global unique ID specified by developer such as: “smart-robot-voice-assistant-2018-v1”. type string deviceType description Required. Some valid device types include: - `action.devices.types.LIGHT`. - `action.devices.types.OUTLET`. - `action.devices.types.SWITCH`. - `action.devices.types.TV`. type string lastUpdatedTime description Last updated timestamp. format google-datetime type string localeData description Required. Locale is in BCP 47 format: en-US, en-CA. items $ref LocaleData type array name description Name of the device model with the form: `projects/{project_id}/deviceModels/{device_model_id}`. type string projectId description Required. Cloud project ID associated with the device model. Projects are allowed to create multiple device models. type string type object DeviceModelCapabilities description Lists capabilities of a Device Model. id DeviceModelCapabilities properties appSetting $ref AppSettingCapability cloud $ref CloudCapability deviceAction $ref DeviceActionCapabilities routine $ref RoutineCapability signInMethod $ref SignInMethod visualOutput $ref VisualOutputCapability wifiCalling $ref WifiCallingCapability type object Dimensions description This contains physical and logical characteristics about the device (e.g. screen size and DPI, etc). id Dimensions properties screenDpi description Dots (pixels) per inch of the screen. format float type number screenHeightPx description Height of the device's screen in pixels. format int32 type integer screenShape description The shape of the device's screen enum SCREEN_SHAPE_UNSPECIFIED SCREEN_SHAPE_OVAL SCREEN_SHAPE_RECT enumDescriptions Screen shape is undefined. A round screen (typically found on most Wear devices). Rectangular screens. type string screenWidthPx description Width of the device's screen in pixels. format int32 type integer type object DisambiguationAnnotation description Annotations from disambiguation dialog. next id: 9 id DisambiguationAnnotation properties conversationId description Assistant conversation id. This is the id to join with user disambigution event, and other dialog annotations. type string disambiguationCandidates description The disambiguate candidates. This is an ordered list in the same order as the ambiguation list displayed for users. items $ref ResultInfo type array disambiguationReason description The reasons why Sophia dialog decides to initiate a disambiguation. This is a repeated field that can contain multiple reasons. items enum DISAMBIGUATION_REASON_UNKNOWN SONG_SONG_DISAMBIGUATION SONG_ALBUM_DISAMBIGUATION enumDescriptions type string type array noDisambiguationReason description The reasons why Sophia dialog decides no disambiguation is needed. items enum NO_DISAMBIGUATION_REASON_UNKNOWN NOT_AMBIGUOUS PREVIOUSLY_DISAMBIGUATED enumDescriptions The results are not ambiguous. This is a general code. If there is more detailed reason from disambigous model, please use the deatailed reason. User has made a successful disambiguation for the same intent before. Thus no need for disambiguation again. type string type array status description The status of the diambiguation dialog. enum DISAMBIGUATION_UNKNOWN DISAMBIGUATION_NOT_NEEDED DISAMBIGUATION_INITIATED DISAMBIGUATION_CONFIRMED DISAMBIGUATION_SUCCEEDED DISAMBIGUATION_CANCELLED enumDescriptions The disambiguation model decides there is no need to trigger disambiguation. A disambiguate flow is initiated, e.g. "Do you mean the album?." The user confirms the disambiguate query. For a confirm query, both "yes" and "no" are confirmations. For list selection disambiguate, any selection or "no thank you" is a confirmation. The disambiguation succeeds. For a confirmed query, "yes" counts as a success. For list selection disambiguate, any selection is a success. User cancels the disambiguation flow. type string topResultCandidate $ref ResultInfo description Top result candidate. The go to play result before disambiguation. type object ExecutionConfig description Specifies the intent's routing capabilities. id ExecutionConfig properties cloudEndpointName description Instructions for performing a cloud execution request for the Intent when the `execution_type` is set to `CLOUD`. If non-empty, then the device execution is routed to the CloudEndpoint specified by this name. The Account Linking exchange may be performed to fetch the OAuth access token, and the access token will be included in the HTTP header. type string intentCommandFormat description Specifies the intent command format for this Action. For example, in order to launch an Android intent instead of receiving the device action payload on the client, then this field can be set with "intent:/#Intent;...;my_extra={$.params.channels[0].channelCode};end" The parameter "{$.params.channels[0].channelCode}" is in JSON path format, and will be replaced with the content from the original device action payload. Thus, with # JSON "execution": [ { "command": "action.devices.commands.SelectChannel", "params": { "channels": [{ "channelName": "exampleChannel", "channelCode": "1-1" }] } } ] as the original action result, then the final result would look like "intent:/#Intent;...;my_extra=\"1-1\";end" type string localDisabled description If this field is set, then local execution capability is disabled for all matching intents. type boolean localExecutionType description Specifies how to execute this Action when it is invoked locally (from the same device). enum DEFAULT CLOUD enumDescriptions Route requests directly to the device via the regular channel. Route all execution requests to cloud. type string remoteDisabled description If this field is set, then remote execution capability is disabled for all matching intents. type boolean remoteExecutionType description Specifies how to execute this Action when it is invoked remotely (from a different device). enum DEFAULT CLOUD enumDescriptions Route requests directly to the device via the regular channel. Route all execution requests to cloud. type string type object InlinedActionCapability description Specifies capabilities for device actions that are inlined in the DeviceAction message. id InlinedActionCapability properties alarm $ref AlarmCapability description Specifies capabilities for handling on-device alarms. The presence of this field, even if empty, implies that the device supports alarms. responseLimits $ref ResponseLimits description Specifies the size limits on responses. If this message is not defined then no limits exist. timer $ref TimerCapability description Specifies capabilities for handling on-device timers. The presence of this field, even if empty, implies that the device supports timers. type object IntValueSpec id IntValueSpec properties maxValue format int64 type string minValue format int64 type string type object Intent description An intent configures the behavior of a device action for this device. id Intent properties argSpecs additionalProperties $ref ArgSpec description List of arguments associated this intent. Each argument must be defined with a template describing the valid arguments. type object executionConfig $ref ExecutionConfig description Instructions for the routing of this Intent. name description The name of the intent. type string providedDataNames description List of provided data names used by this intent. Note that some built-in intents will not function properly without provided data, such as `action.intent.SwitchChannel` or `action.intent.AppSelector`. items type string type array securityConfig $ref SecurityConfig description Security configuration for this Intent. type object ListDeviceModelsResponse description Response message for DevicesPlatformExternalService.ListDeviceModels. id ListDeviceModelsResponse properties deviceModels items $ref DeviceModel type array type object LocaleData description Localized Device Model metadata. id LocaleData properties locale description Required. Locale is in BCP 47 format: en-US, en-CA. type string manifest $ref Manifest description Required. Metadata that describes the device model and manufacturer. This will be shown in the SDK console, metrics dashboards, and other related visual interfaces. type object LocalizedApps description Apps are available in various locales. For each locale, a set of global apps can be defined. id LocalizedApps properties apps description List of supported apps for this locale. items $ref App type array locale description Locale is in BCP 47 format. eg. en-US, en-CA. type string type object LocalizedChannels description Channels are available in various locales. For each locale, a set of global channels can be defined. id LocalizedChannels properties channels items $ref Channel type array locale description Locale is in BCP 47 format. eg. en-US, en-CA. type string type object Manifest description Metadata that describes the device model and manufacturer. This will be shown in the SDK console, metrics dashboards, and other related visual interfaces. id Manifest properties defaultNames description Optional. Set of nicknames provided to target the device correctly during assistant interactions. items type string type array deviceDescription description Description of this device model, such as "Sample robot with the Google Assistant Built-in". type string logoUrl description The URL to the LOGO image of the manufacturer. The manufacturer's LOGO is used on the disclosure page in adjunction to Google Assistant's own LOGO. The LOGO image should be a .svg file and have a transparent background. type string manufacturer description Required. Manufacturer of this device model, such as "Robot corp.". This may be used to name the device for remote execution. type string productName description Required. Consumer facing product name for this device model, such as "Sample Robot 2018". This may be used to name the device for remote execution. type string type object MusicQueryInfo description Message used for intent logging of broad queries. go/ytm-broad-query-experiments Next ID: 7. id MusicQueryInfo properties genre description Genre intent if it's a broad music query. enum GENRE_TYPE_UNSPECIFIED AFROBEATS ALTERNATIVE_INDIE AXE BENGALI_FILM_POP BHOJPURI_FILM_POP BLUES CANTOPOP_HK_POP CHILDRENS_MUSIC CHRISTIAN CLASSICAL COMEDY_SPOKEN_WORD_OTHER COUNTRY DANCE_ELECTRONIC FOLK FORRO FRENCH_VARIETIES FUNK_BRASILEIRO GHAZAL GOSPEL GUJARATI_FILM_POP HINDI_FILM_POP HIP_HOP_RAP HOLIDAY INDIAN_CLASSICAL INDIAN_DEVOTIONAL INDIAN_FILM_POP_OTHER_LANGUAGES INDIAN_FOLK INDIAN_POP INDIAN_FILM_POP INDIAN_HIP_HOP JAZZ J_POP KANNADA_FILM_POP KOREA_BALLADS KOREA_DANCE KOREA_TROT K_POP LATIN_POP LATIN_URBANO MALAYALAM_FILM_POP MANDOPOP MARATHI_FILM_POP METAL MPB MUSIQUE_FRANCOPHONE MUSICA_TROPICALE NATURAL_SOUNDS NEW_AGE POP PUNJABI_FILM_POP RAP_QUEB REGGAE REGIONAL_BRAZILIAN REGIONAL_MEXICAN ROCK RUMBA_FLAMENCA R_B_SOUL SAMBA_E_PAGODE SCHLAGER_VOLKSMUSIK SERTANEJO SOUNDTRACKS TAMIL_FILM_POP TELUGU_FILM_POP UK_RAP ADULT_CONTEMPORARY AFROPOP ANIME AUSTRALIAN_HIP_HOP_RAP BHANGRA BRASIL_EDM CANTAUTORES CANTAUTORI_ITALIANI DANISH_HIP_HOP DANISH_POP DISCO_POLO DUTCH_POP DUTCH_RAP FADO FINNISH_HIP_HOP FINNISH_POP FINNISH_ROCK FRENCH_HIP_HOP FRENCH_POP GERMAN_HIP_HOP GERMAN_POP GERMAN_ROCK GRIME HIP_HOP_BRASILERO HIP_HOP_EN_ESPANOL HORBUCHER HORSPIELE ITALIAN_HIP_HOP ITALIAN_POP JAPAN_ALT_INDIE JAPAN_CHILDRENS_MUSIC JAPAN_COMEDY_SPOKEN_WORD JAPAN_DANCE_ELECTRONIC JAPAN_EDM JAPAN_HIP_HOP JAPAN_REGGAE JAPAN_ROCK KARAOKE KAYOKYOKU KOREA_ALTERNATIVE_ROCK KOREA_ALT_INDIE KOREA_CCM KOREA_CHILDRENS_MUSIC KOREA_EDM KOREA_HIP_HOP_RAP KOREA_INDIE_FOLK KOREA_OST KOREA_REGGAE KOREA_ROCK KOREA_R_B_SOUL KOREA_TRADITIONAL_MUSIC LATIN_TRAP MUSICA_RELIGIOSA POLISH_POP POP_NACIONAL PORTUGUESE_HIP_HOP PORTUGUESE_POP_ROCK ROCK_EN_ESPANOL ROCK_NACIONAL ROCK_Y_ALTERNATIVO RUSSIAN_HIP_HOP_RAP RUSSIAN_POP RUSSIAN_ROCK RUSSIAN_SHANSON SINGER_SONGWRITER SPANISH_HIP_HOP TURKISH_HIP_HOP URDU_FILM_POP VOCAL_EASY_LISTENING WORLD enumDeprecated False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True enumDescriptions Música popular brasileira Deprecated TLGs. type string genreMid description KG mids associated with a genre music query. For a query like "classic rock", there will be 2 KG mids: 1. One for "rock" - Top Level Genre 2. One for "classic rock" - sub-genre of "rock" KG mids are ordered by confidence_score from Query Understanding in case of multiple genres. For "classic rock" query, "classic rock" KG mid is likely to precede "rock" KG mid. items type string type array moodActivity description MoodActivity intent if it's a broad music query. enum INTENT_UNKNOWN INTENT_HOME INTENT_WORK INTENT_COMMUTE INTENT_WORKOUT INTENT_SLEEP INTENT_FOCUS INTENT_RELAX INTENT_FEEL_GOOD INTENT_ENERGIZE INTENT_SAD INTENT_FAMILY INTENT_PODCAST INTENT_ROMANCE INTENT_PARTY enumDeprecated False True True False False False False False False False False False False False False enumDescriptions type string queryIntent enum QUERY_INTENT_UNKNOWN SONG ARTIST ALBUM PLAYLIST_PERSONAL PLAYLIST_PUBLIC PLAY_MUSIC_GENERAL RECOMMEND_MUSIC GENRE MOOD ACTIVITY LIKED_SONGS enumDescriptions Personal playlists including auto-generated playlists such as ‘Liked songs.’ Set when user is requesting a specific public playlist (includes programmed playlists, topical mixes, etc.) Unconstrained 'Play Music' query, in which the user provides no additional arguments. 'Recommend Music' query. On Assistant this results in a set of playlists which the user can traverse by saying 'play something else.' Genre queries, e.g. jazz music. Mood query, e.g. happy music. Activity query, e.g. workout music. Liked songs intent, e.g. 'play my liked songs'. type string queryType enum QUERY_TYPE_UNKNOWN NAVIGATIONAL BROAD enumDescriptions Queries for a specific album, artist, song, or playlist (including personal playlists.) Queries that do not correspond to a specific entity. Includes moods, genres, decades, activities, etc. type string seekingLockerContent description Denotes if the intent was to play locker track/album/artist. type boolean type object MusicTrackData description Music Track data. Next ID: 3 id MusicTrackData properties videoId description Encrypted youtube external video id. type string videoSid description Surrogate field for video_id. format int64 type string type object OptionValueSpec id OptionValueSpec properties values items type string type array type object PRequestContext description Represents the public API for storing pToken/privacy attributes in PrivacyContext, to be automatically propagated across RPC chains. Public and testing APIs exist in C++ and Java: - google3/privacy/ptoken/public/propagation/ - google3/privacy/ptoken/public/request_context.h - google3/privacy/ptoken/public/testing/request_context.h - google3/privacy/ptoken/public/logging/request_context_logging.h - google3/java/com/google/privacy/ptoken/propagation/RequestContextApi.java - google3/java/com/google/privacy/ptoken/propagation/RequestContextTestingApi.java - google3/java/com/google/privacy/ptoken/propagation/RequestContextLoggingApi.java NOTES: - Be careful when modifying this proto because it's potentially included in every RPC request in the fleet. Be careful with its size, and with backward compatibility of changes. - PRequestContext must include ONLY basic types and Enums. This is required in order to avoid external dependencies in the logged container (per go/proto-guidelines). - Some fields are mirrored in LoggedPRequestContext at //logs/proto/privacy/ptoken/logged_request_context.proto, which must remain wire-compatible with this proto. Any fields that appear in both must use the same type and tag number. When deleting a field from PRequestContext, the LoggedPRequestContext version must remain for backwards compatibility of stored data, so please migrate its documentation to the LoggedPRequestContext message. For more details on LoggedPRequestContext see go/ptoken-prc-logs. - Each field should have a comment specifying the needed merge logic. Per-field merging and modification must be implemented in C++ and Java. See go/prequestcontext#new-field. See go/ptoken-rfc-prequestcontext for more details. Next ID: 37 id PRequestContext properties adsProcessingPurpose description The ads processing purpose for which processing is happening. Value & enum copied from ProcessingPurpose proto. This will be used in combination with processing purpose to provide DMA 5(2) exemptions. Merge logic is take the entire new processing_purpose if present. items enum DATA_USAGE_NONE DATA_USAGE_TARGETING DATA_USAGE_NEGATIVE_AD_SELECTION_NEEDS_PRIVACY_APPROVAL DATA_USAGE_LOGGING DATA_USAGE_GENERATE_PREDICTION_QEM DATA_USAGE_GENERATE_PREDICTION_QEM_WITH_CARVEOUT_NEEDS_PRIVACY_APPROVAL DATA_USAGE_LOGGING_FOR_TARGETING DATA_USAGE_PRIVACY_CONTROL_NEEDS_PRIVACY_APPROVAL DATA_USAGE_AD_EXCHANGE DATA_USAGE_ADSPAM DATA_USAGE_READ_FOR_KANSAS_WRITE DATA_USAGE_MEASUREMENT_EXTERNAL DATA_USAGE_MEASUREMENT DATA_USAGE_EXPERIMENTS DATA_USAGE_AGGREGATE_SERVER_METRICS DATA_USAGE_CHECK_COOKIE_LINKAGE_NEEDS_PRIVACY_APPROVAL DATA_USAGE_COOKIE_MATCHING DATA_USAGE_CLICK_URL_CUSTOMIZATION DATA_USAGE_ADX_TARGETING_IN_SUPERMIXER DATA_USAGE_TRIGGER_ELIGIBLE_COOKIE_LINK_NEEDS_PRIVACY_APPROVAL DATA_USAGE_SHARE_EXTERNALLY DATA_USAGE_CROSS_DOMAIN_SEQUENCING_NEEDS_PRIVACY_APPROVAL DATA_USAGE_PUBLISHER_DATA_PREDICTION_PROCESSING_AND_SHARING DATA_USAGE_UI_CUSTOMIZATION DATA_USAGE_POLICY_CONTROL_NEEDS_PRIVACY_APPROVAL DATA_USAGE_COUNTERFACTUAL_EXPERIMENT DATA_USAGE_FILL_CLICK_URL_DATA_NEEDS_PRIVACY_APPROVAL_DEPRECATED DATA_USAGE_MUTES DATA_USAGE_READ_LOC_CONTEXT_FOR_GEO_LOC_DATA_PROTO_NEEDS_PRIVACY_APPROVAL DATA_USAGE_READ_FROM_CACHE_NEEDS_PRIVACY_APPROVAL DATA_USAGE_VIDEO_ADS_SEQUENCING DATA_USAGE_A1_INFRA_DMA52_POLICY_CONTROL_CARVE_OUT_NEEDS_PRIVACY_APPROVAL DATA_USAGE_STORE_VISIT_LIFT_MEASUREMENT DATA_USAGE_SURVEY_LIFT DATA_USAGE_SHARE_EXTERNALLY_IN_BID_REQUESTS DATA_USAGE_INFRASTRUCTURE_METRICS_NEEDS_PRIVACY_APPROVAL DATA_USAGE_PROVISION_OF_SERVICE_INFRASTRUCTURE_NEEDS_PRIVACY_APPROVAL DATA_USAGE_VERIFICATION_TESTING_VALIDATION_NEEDS_PRIVACY_APPROVAL DATA_USAGE_MEDIATION_GROUP_SELECTION DATA_USAGE_CONVERSION_ATTRIBUTION DATA_USAGE_A1_INFRA_AADC_INFERENCE_PRIVACY_CONTROL_CARVEOUT enumDeprecated False False False False False False False False False False False False False False False False False False False False False False False False False False True False False False False False False False False False False False False False False enumDescriptions Selecting/filtering ads. All typical usages of data within a targeting server (positive/negative targeting, filtering, etc) can be represented using this value. There are only a few exceptions in targeting servers that should use DATA_USAGE_NEGATIVE_AD_SELECTION_NEEDS_PRIVACY_APPROVAL instead. See DATA_USAGE_GENERATE_PREDICTION_QEM for a special case of targeting. This is a subclass of targeting that refers to usages of user data that limit the number of times a certain ad is shown. The primary example for this is frequency capping, but other features (for example, app-install based filtering) may also qualify. For some profiles (impression history in particular), this usage has privacy carveouts to be allowed for targeting-restricted requests. For mute ads and advertisers mutes, please use DATA_USAGE_MUTES instead. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/SAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR THIS USAGE! Logging to sawmill logs (not task logs). Note that the policy for DATA_USAGE_LOGGING is implemented as a subset of privacy-allowable policy to support quality considerations, as models train off of logs and want to avoid logging data that can't be used for targeting (which causes training/prediction skew). Usage of user data for creation of prediction QEMs. Do not use this for general targeting. This usage is only for creating prediction (mini-)QEMs. A special version of the GENERATE_PREDICTION_QEM that is eligible to include user data with privacy carveouts under the condition that the prediction models do not cross any such carveout data with interest categories. This allows, e.g., frequency capping profiles to be used as per-ad-candidate prediction signals on privacy sensitive requests. NOTE: As of 2021`Q2 this usage is confined only to Gmob mixer and only supports legacy cases. PLEASE DO NOT ADD NEW USE CASES; if there are really new use cases that fit this carveout, they should be incorporated into enforcement detailed in go/daml-privacy-enforcement-design, not blithely promised by the accessing client via this usage. Refers to usages of user data where logging happens specifically for targeting. For example, impression history is generally allowed to be logged (for fcap), but there are products such as ads reach which log impression history only to build targeting models, which should not receive carveouts for privacy sensitive requests. Accordingly, we map this use case to a more strict subset of generic logging. Usage of user data for enforcement of privacy logic or privacy risk mitigations, e.g., fetching of privacy risk metrics by AdX for reidentification mitigation. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. For pToken policy engine (aka Tokotoko), this usage is equivalent to ProcessingPurpose::COMPLIANCE_LEGAL_SUPPORT. Sending the user profiles to AdX RTBs. DATA_USAGE_SHARE_EXTERNALLY_IN_BID_REQUESTS will eventually replace DATA_USAGE_AD_EXCHANGE. A new data usage is required to conduct serving experiments with privacy policy changes applicable to DATA_USAGE_AD_EXCHANGE, such as access to the hosted match data for RTB partners. Used for serving or offline jobs for detecting spam. For pToken policy engine (aka Tokotoko), this usage is equivalent to ProcessingPurpose::TRUST_SAFETY_ANTI_FRAUD. Refers to using user data in order to create data that will be written to Kansas. Refers to usages of user data that enable measurent for publisher, advertisers, or any other external entities. For example, if the data is used to create pixels meant to be used by external companies, you should use DATA_USAGE_MEASUREMENT_EXTERNAL. Refers to using user data for measurement, e.g., conversion tracking, internal/external aggregate ads reporting, internal analysis etc. This is meant for measurement done by Google (i.e. internal). For measurement that involves individual user data (not aggregate metrics) sharing with external entities, please use DATA_USAGE_MEASUREMENT_EXTERNAL. Refers to using user data for experiment conditions. In particular, setting request properties. This is a special usage that refers to accessing user profiles in order to update varzs and streamzs that store aggregate information about the user profiles loaded (e.g., number of user profiles for the request). Do not use this for storing aggregate data in Kansas or logs. Refers to the usage of user data to determine whether or not a user has links on Mobius/Constellation/AdX Hosted Match, etc, for ephemeral, not-privacy related purposes. DO NOT USE THIS VALUE IF YOU USE THE COOKIE LINK STATUS TO MAKE PRIVACY RELATED DECISIONS! USE THIS VALUE ONLY TO CHECK FOR THE PRESENCE OF LINKS, NOT TO ACCESS ANY TARGET COOKIE. FOR ACCESS TO THE LINK TARGET, USE THE ACTUAL INTENDED USAGE INSTEAD, e.g. DATA_USAGE_TARGETING. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to usages of user data for initiating cookie matching. For example, using hosted match data to initiate push cookie matching. Refers to usages of user data for customizing the click URL. For example, using app install data to change the click URL depending on whether the promoted app is installed. AdX must not use user profiles in GAIA profile space which will generally be enforced by UDA execution context. We have some AdX specific UDA usages in supermixer that would get access to GAIA profiles because they are executed within Supermixer's ExecutionContext. To prevent access to GAIA profiles in these cases, we added DATA_USAGE_ADX_TARGETING_IN_SUPERMIXER with accordingly defined privacy policy rules. THIS IS SOMEWHAT HACKY so please don't copy this pattern elsewhere. DO NOT INTRODUCE ANY NEW USAGES OF THIS VALUE. Instead, all AdX specific code should be moved to AdX servers. Refers to the usage of user data to determine whether or not app cookie ( Device ID) can link to mobile web cookie(mobile browser DBL cookie), and trigger the actual linking if eligible. See go/mobius-impression-time-linking for more details. DISTIGUISH THIS WITH DATA_USAGE_CHECK_COOKIE_LINKAGE_NEEDS_PRIVACY_APPROVAL WHICH IS FOR CHECKING THE PRESENCE OF LINKS. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to usages of user data that are getting sent to external companies. Note that this usage does not allow data to be shared with bidders. This refers to usages of user data for ad sequencing, on the same site or across domains. Examples include ad rule and sequential rotation. Viral uses it for Video ad sequencing (go/videoads-sequence). Ad sequencing is similar to frequency capping/negative ad selection, except that there is a larger targeting/business motivation. Accordingly, some (but not all) carvouts for frequency capping apply also to ad sequencing. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to the processing of publisher-related user data by ML prediction and sharing the results with publishers for their benefit (not necessarily ads personalization). This is used for Subscription Optimization. For example, reading the propensity score of a user to subscribe to a publication, and sending it to the external publisher. For more information, please see go/sos-ml2 and go/subopt-ga-dd. Refers to usages of user data as an information provider. Data with this usage will not be used for ads personalization. For example, using cart data to calculate the quantity of cart items and display it in frontend. Refers to usages of user data for enforcement of policy control logic. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/SAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. DATA_USAGE_POLICY_CONTROL_NEEDS_PRIVACY_APPROVAL is a DMA5(2) exempted data usage approved in b/285159517 Refers to pass-through of user data for counterfactual experiment requests, in particular raw kansas lookup data. See go/experiment-counterfactuals#about-counterfactuals for background on counterfactuals. Notice: this should only be used in combination with proper fine-grained DATA_USAGE enforcement when the pass-through data is subsequently consumed in the mixer. See http://shortn/_2sEjLivCfa for more background. Refers to usage of data to populate a clickstring sent to event servers. Privacy checks at event time must ensure this data is safely used. PLEASE NOTE THAT POLICY IS ONLY IMPLEMENTED FOR PSEUDONYMOUS IDENTIFIERS. DO NOT USE THIS USAGE UNLESS YOU HAVE EXPLICITLY CONFIRMED THAT THE POLICY EXISTS FOR YOUR PROFILE (PROBABALY BY TALKING TO SAPT). THIS USAGE IS DEPRECATED; PLEASE DO NOT ADD NEW USE CASES WITHOUT CONSULTING SAPT. Refers to usage of user data to block/mute ads and advertisers as a result of user action (e.g., through "Block this ad" in My Ad Center). Refers to usage of data to populate GeoLocationData, which will be consumed to construct GeoDataAccessor inside Supermixer. The data comes from LES response. Please check go/les-response-paperplane for more details. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/SAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to reading user data from a cache, where the cache was populated with either the original or derived user data that had already passed the privacy checks for the original intended data usage. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/SAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to usage of user data for video ads sequencing. Refer to go/videoads-sequence for details. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to usage of user data for A1 infrastructure carve outs for DMA5(2). This usage will be used for carve outs with a non targeting purpose. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/SAPT/A1 HAS EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to usage of user data to determine whether we should do diversion for store visit lift experiments based on whether the user's location history is active. Created for FEATURE_STORE_VISIT_LIFT_MEASUREMENT for finer-grained usages. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to usage of user data to determine whether we should use user data for survey lift. Created for FEATURE_SURVEY_LIFT for finer-grained usages. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Share data externally in bid requests with RTB partners (products such as Authorized Buyers, Open Bidding, SDK bidding). This will serve as an eventual replacement for DATA_USAGE_AD_EXCHANGE. A new data usage is required to conduct serving experiments with privacy policy changes applicable to DATA_USAGE_AD_EXCHANGE, such as access to the hosted match data for RTB partners. We will be gradually migrating usages of DATA_USAGE_AD_EXCHANGE to DATA_USAGE_SHARE_EXTERNALLY_IN_BID_REQUESTS through serving experiments. DO NOT USE (YET). For now, new accesses of data for the purposes of populating in RTB bid requests should continue to use DATA_USAGE_AD_EXCHANGE, since privacy policies have not yet been fully updated to reference DATA_USAGE_SHARE_EXTERNALLY_IN_BID_REQUESTS. Once privacy policies are updated, new uses DATA_USAGE_SHARE_EXTERNALLY_IN_BID_REQUESTS will be allowed. For pToken policy engine (aka Tokotoko) compatibility ONLY. This usage is equivalent to ProcessingPurpose::INFRASTRUCTURE_METRICS. Any processing for the purpose of understanding how services and products are used by users and to gain insights into how the underlying infrastructure performs during their operation: e.g. any processing necessary to monitor a service and its performance to maintain product excellence, reliability, service quality, or other technical measures as perceived by a user - [description based on the corresponding ProcessingPurpose enum but excludes "traffic shaping" - see note below]. NOTE: The original ProcessingPurpose description includes "traffic shaping"; however, as discussed in screen/ZLddAkXK5ozwEbD, "metrics" usage should be limited to passive operations and traffic shaping is not passive. Therefore, for DATA_USAGE we have removed "traffic shaping" as a possible reason to use this value. USE of this VALUE is LIMITED to Stargate clients that need mapping from ProcessingPurpose to DataUsage for DMA 5(2) processing purpose exemptions (Goldfish and KeyVal only at this point). For pToken policy engine (aka Tokotoko) compatibility ONLY. This usage is equivalent to ProcessingPurpose::PROVISION_OF_SERVICE_INFRASTRUCTURE. This processing purpose may be used by jobs implementing low level multi-tenant infrastructure (e.g., Spanner, Sawmill, PS1). This purpose will grant an exemption to the DMA 5(2) policy, and, thus, its use is regulated (go/dma52-exemptions) - [description copied verbatim from the corresponding ProcessingPurpose enum]. USE of this VALUE is LIMITED to Stargate clients that need mapping from ProcessingPurpose to DataUsage for DMA 5(2) processing purpose exemptions (Goldfish and KeyVal only at this point). For pToken policy engine (aka Tokotoko) compatibility ONLY. This usage is equivalent to ProcessingPurpose::VERIFICATION_TESTING_VALIDATION. Processing for debugging or monitoring or somehow related to pure software functionality. Access in order to perform testing, verification, certification, or other routine or pre-launch analysis by using stored user data. This can include regression testing, load testing, unit/integration testing, or other analysis of machine-generated or replayed activity. This is done primarily for routinized, transient evaluation like testing new builds/deployments - [description copied verbatim from the corresponding ProcessingPurpose enum]. USE of this VALUE is LIMITED to Stargate clients that need mapping from ProcessingPurpose to DataUsage for DMA 5(2) processing purpose exemptions (Goldfish and KeyVal only at this point). For AdMob Mediation Group Selection usage ONLY. AdMob mediation group allows publisher to select a group of ad networks to compete for a specific ad request. This data usage is used to read the publisher provided data for mediation group selection purposes. The publisher provided data would not be sent to ad networks (including google demand) and would not be used for any other purposes. For more details, please refer to go/admob-mg-kv-dd. For conversion attribution/tracking usage ONLY. In particular, this data usage should be used for any APPROVED conversion attribution clients that rely on Ads Dual Observation (go/stargate-enforcement-for-ads-do). This is a subset of DATA_USAGE_MEASUREMENT. For non-conversion attribution clients, please use DATA_USAGE_MEASUREMENT instead. WARNING: This data usage is UNDER CONSTRUCTION. DO NOT USE IT without consulting with SAPT (PoC: sadiam@) For A1 infrastructure AADC inference profile building usage ONLY. The restrictions for this use-case are not able to be fully enforced using UDA PMv2 policy as of now and will have similar restrictions as DATA_USAGE_PRIVACY_CONTROL_NEEDS_PRIVACY_APPROVAL in the PMv2 policy. Additional restrictions will be applied using custom UDA enforcement utils outside of the PMv2 policy. See go/yt-organic-privacy-signal-propgation-and-enforcement-in-stargate for more details. WARNING: This data usage is only intended for A1 infrastructure. DO NOT USE IT without consulting with SAPT (PoC: saddo@) type string type array assistantGuestModeEnabled description Whether or not Assistant Guest Mode is in effect for this request. Should be explicitly set to false when AGM is known to be disabled to allow differentiation between known and unknown states (e.g. to catch potential propagation failures). Merge logic is logical OR. type boolean assistantIsSubjectToMinorModeRestrictionsForGuests description See go/ptoken-policy-assistant-aadc and go/assistant-aadc-logging-design for more on these two bits. Whether the account associated with the Assistant request is in a region in which Minor Mode (AADC) restrictions apply to ambiguous requests ("guests" in AADC terminology, but may be expanded later). Derived from IsSubjectToMinorModeRestrictionsForGuests account capability, where the AADC (and potential future geo->regulatory) decisions live. Merge logic is logical OR. type boolean assistantPocketIsEnabled description Whether this request has Pocket enabled. This is currently decided by device type and user opt-in status. We didn''t create separate bool fields for opt-in status and device type because the opt-in machanism is designed to let server treat request as if user was using Pocket-eligible devices. So the difference between eligibility from device type and eligibility from opt-in is delibrately abstracted away from the policy layer. See go/pocket-21 Merge logic is logical or. type boolean assistantPocketTriggeredFeatures description The triggered features in the Assistant response that are in the scope of Pocket. See go/pocket-21 Merge by set union. items enum UNKNOWN_POCKET_FEATURE POCKET_FEATURE_ACTION_TELEPORT_OPEN_APP POCKET_FEATURE_APP_CONTROL POCKET_FEATURE_DIGITAL_WELLBEING POCKET_FEATURE_INTENT_ACTION_PHOTO_FEATURE POCKET_FEATURE_LANGUAGE_PICKER_FEATURE POCKET_FEATURE_POWER POCKET_FEATURE_SLEEP_TIMER_SET_FEATURE POCKET_FEATURE_SLIDER_SETTING_FEATURE POCKET_FEATURE_TAKE_SCREENSHOT_FEATURE POCKET_FEATURE_TOGGLE_SETTING_FEATURE enumDescriptions go/keep-sorted start go/keep-sorted end type string type array assistantRequestAcceptanceStatus description The status of assistant request being accepted. By default the status is UNKNOWN, and it changes to AWAITING when the assistant server receives the request, and ACCEPTED when the assistant server determines that the request is intended, or REJECTED when the request is unintended. The request can also be CANCELLED by the Assistant (go/armaa-cancellations) or explicitly set to EXPLICIT_UNDEFINED (introduced for go/robin-hotword-sanitization). See go/ptoken-rfc-assistant-activation Contact: go/peals for inquiries and consultations on the policy compliance. Merge on the pRC is OVERWRITE by the priority value. Note that there is a different behavior for merging on pTokens. See the proto definition for more details. enum REQUEST_ACCEPTANCE_UNSPECIFIED REQUEST_ACCEPTANCE_AWAITING REQUEST_ACCEPTANCE_ACCEPTED REQUEST_ACCEPTANCE_REJECTED REQUEST_ACCEPTANCE_CANCELLED REQUEST_ACCEPTANCE_EXPLICIT_UNDEFINED REQUEST_ACCEPTANCE_AWAITING_WEAK REQUEST_ACCEPTANCE_ACCEPTED_WEAK REQUEST_ACCEPTANCE_REJECTED_WEAK enumDescriptions Unknown whether acceptance policy is applicable Applicable but waiting for the decision The request is accepted The request is rejected The request is cancelled. Note a REQUEST_ACCEPTANCE_CANCELLED_WEAK state is not needed because cancellation is an unambiguous signal that will not differ between different versions of Assistant Server code. See go/armaa-cancellations for more details. This request is explicitly set as undefined, in other words the request won't have a conclusive status for this request, and no one should override this value. Similar to the CANCELLED state, this is an unambiguous signal that won't be contested, and therefore does not need WEAK version. This status was introduced for go/robin-hotword-sanitization. Similar as above states, except that weak states cannot override the above states. type string assistantSurfaceRestriction description Assistant Surface restriction - describes Assistant Device's state relevant for policies. See go/ptoken-assistant-guest-logging for more details, Set once only. enum ASSISTANT_SURFACE_RESTRICTION_UNSPECIFIED ASSISTANT_SURFACE_RESTRICTION_GOOGLE_HOME_AADC_LOGGING ASSISTANT_SURFACE_RESTRICTION_VM_ENROLLED_ATV_AADC_LOGGING ASSISTANT_SURFACE_RESTRICTION_DOCKED_LOCKED_TKY_GUEST_LOGGING ASSISTANT_SURFACE_RESTRICTION_ACTION_BLOCKS ASSISTANT_SURFACE_RESTRICTION_VOICE_ACCESS ASSISTANT_SURFACE_RESTRICTION_ROBIN ASSISTANT_SURFACE_RESTRICTION_UNVERIFIABLE_OR_UNENROLLED enumDescriptions Google Home like shared devices (speakers, displays) subject to aadc. go/assistant-aadc-design for details. Voice Match enrolled Android TVs, ATVs without Voice Match are not yet applying AADC. Ref. go/assistant-aadc-tv. Docked and Locked Android based tablets are treated as shared devices and subject to guest logging globally. go/tky-guest-logging for details. Queries from Accessibility app Action blocks on mobile. Refer to go/limit-ab-logs for details. Queries originating from a Voice Access session (type of accessibility feature inside AGA), Refer to go/va-as-logs for details Queries originating from the Assistant with Bard (Robin) application. Refer to go/ptoken-policy-assistant-robin-surface-restriction. Queries originating from an Assistant surface where only biometric identification is available to identify the user, but no enrollment is present. Refer to go/ptoken-policy-assistant-global-guest-logging. type string assistantUserIdentityIsAmbiguous description Whether this request could not be confirmed (through Voice Match (VM), Face Match (FM), etc.) to be coming from the requesting user. This can happen when VM fails, or when VM is not set up on the device. Merge logic is OVERWRITE, see go/aadc-prc for background and implications. type boolean bardRequestTimeUserHistorySetting description Status of a Bard user's history toggle at the request time. See go/bard-history-off-ptoken-policy. Merge logic is `set once`, aka original value wins. See go/bard-user-history-setting-merge. enum HISTORY_SETTING_UNKNOWN HISTORY_SETTING_RETRIEVAL_FAILED HISTORY_SETTING_ON HISTORY_SETTING_OFF enumDescriptions Indicates error in setting retrieval from FACS (either RPC or internal). User allows history to be collected. User does not allow history collecion. type string bitfieldSet format byte type string bitfieldValue description PrivacyContext bitfields value and is set. Values are correlated, but are not combined into submessage to save additional tag in serialized format. See go/ptoken-privacycontext-bitfields For bitfield definition see: google3/privacy/context/proto/privacy_context_bitfield.proto format byte type string datasetProductIds deprecated True description A list of product ids specifies the product association of the dataset. Not to be confused with 'origin_associated_product_id' which specifies the product association of the rpc. This field is used for writes to storage systems that create datasets on the fly as opposed through a schema update/push (e.g. CNS/Napa Express) and should not be used for any other flows. Note that this field is size limited to 4 and it uses a signal value '-1' which represents the dataset is associated with 'AnyProduct'. Merge logic is overwrite, max number of values is 4. See go/datasetattributes-to-prequestcontext-api. items format int32 type integer type array deferredSemanticPurposes description The deferred semantic purposes of the request. See go/processing-purpose-v2?tab=t.0#heading=h.ccv6l1t8rpwz for more details. This field is tighly coupled with the `semantic_purpose` field above, and will only be set if the `semantic_purpose` field is set to the deferred value. items enum SEMANTIC_PURPOSE_UNSPECIFIED SEMANTIC_PURPOSE_SERVICE_DELIVERY SEMANTIC_PURPOSE_LEGAL_OBLIGATION enumDescriptions The semantic purpose is unset To provide and maintain Google services, products and features. To protect Google, our users, and the public. type string type array dma52CrossUseOfferedTogether description Cross use offered together as described by go/dma52-cuot. Set to true if data processing involves a cross-use with services offered together. This field may be unset or explicitly set to false. Both values have the same semantics for policy enforcement, but may result in nuanced handling by the Defaults mechanism; please see go/dma:cuot:clearing for more details. Merge logic is overwrite, aka "latest value wins". type boolean dma52ProcessingType description Used for offline dataset ownership propagation for dma52 as described by go/dma52-dataset-ownership-propagation. Processing systems (such as flume, sqlp etc) will set the value to PROCESSING_TYPE_COPY if they are performing single or multi CPS copies, and will set the value to PROCESSING_TYPE_COMBINATION if they are processing the data and taking ownership of the read data. For DMA5(2), we believe most of offline jobs to perform PROCESSING_TYPE_COMBINATION. Merge logic is overwrite, aka "latest value wins". Note: If the value is unspecified then PROCESSING_TYPE_COMBINATION will be assumed. enum PROCESSING_TYPE_UNSPECIFIED PROCESSING_TYPE_COMBINATION PROCESSING_TYPE_COPY PROCESSING_TYPE_ML_INFERENCE enumDescriptions type string essentialUseConsentState description A user's essential only mode setting. See go/search-eom-ptoken, go/yt-eom-ptoken and proto definition for more details. Merge logic uses max value. enum ESSENTIAL_USE_CONSENT_STATE_UNSPECIFIED ESSENTIAL_USE_CONSENT_STATE_REGION_OUT_OF_SCOPE ESSENTIAL_USE_CONSENT_STATE_APPLICATION_OUT_OF_SCOPE ESSENTIAL_USE_CONSENT_STATE_SIGNED_IN_OUT_OF_SCOPE ESSENTIAL_USE_CONSENT_STATE_UNRESTRICTED ESSENTIAL_USE_CONSENT_STATE_ESSENTIAL_ONLY enumDescriptions The default value, if the consent state is unset. User is not in essential only mode *and* has not explicitly given consent for non-essential uses of activity data. This corresponds to signed-out users from regions not under EOM policies. User is not in essential only mode *and* has not explicitly given consent for non-essential uses of activity data. This corresponds to signed-out users from in-scope region, but from unsupported applications. User is signed in and has given explicit consent when creating an account. See go/yt-eom-signed-in-enum for details. User is not in essential only mode *and* user has explicitly given consent for non-essential uses of activity data. This corresponds to signed-out users from regions under EOM policies. User is in essential only mode, because the user: - has explicitly declined using activity data for non-essential purposes, - or has not made a decision yet (and user is in region under EOM policies, where we treat the user by default as EOM until they consent). Only signed out users from regions under EOM policies are eligible to set this. type string geoLocationLookupStatus description Status of a request routing lookup of GeoLocationRestriction. This field is used by routing services (i.e. Compass/Bearing for Olympus) to indicate a successful lookup or why a lookup failed. enum GEO_LOCATION_LOOKUP_STATUS_UNSPECIFIED GEO_LOCATION_LOOKUP_STATUS_SUCCESS GEO_LOCATION_LOOKUP_STATUS_ESS_FAILURE GEO_LOCATION_LOOKUP_STATUS_HOMEMAP_FAILURE GEO_LOCATION_LOOKUP_STATUS_HOMEMAP_NOT_FOUND GEO_LOCATION_LOOKUP_STATUS_HOMEMAP_MISSING_POLICY GEO_LOCATION_LOOKUP_STATUS_AUTH_FAILURE GEO_LOCATION_LOOKUP_STATUS_RPC_FAILURE GEO_LOCATION_LOOKUP_STATUS_MALFORMED_REQUEST GEO_LOCATION_LOOKUP_STATUS_ESS_NOT_FOUND GEO_LOCATION_LOOKUP_STATUS_TENANT_CONFIG_ERROR GEO_LOCATION_LOOKUP_STATUS_UNKNOWN_CODE_ERROR GEO_LOCATION_LOOKUP_STATUS_EMERGENCY_REDIRECT enumDescriptions No Olympus policy was present in the home map. This can happen because of Storage fail-open. The incoming RPC to the lookup service itself has failed. A routing ID could not be determined because of a problem with the request. Examples include invalid or missing IDs and invalid authentication credentials. The server is expected to reject the request early with a client error (`INVALID_ARGUMENT`, `UNAUTHENTICATED`, `PERMISSION_DENIED`) or an HTTP redirect. An OK response indicates a violation. type string isDarkLaunchRequest description When true, designates that the request is a Search PA-level dark launch request - a special kind of synthetic non user-facing request whose value was derived from some user-facing request to some production server. WARNING: Setting this field to true has far reaching effects on how the production systems handle user-data generated by this request. In general though not always, user-data is NOT written when this field is set to true. IMPORTANT: Given the potential for misuse, it is imperitive you reach out to both ptoken-eng@ and search-dark-launch-team@ before attempting to set this field for some new usecase. See go/ptoken-policy-search-dle for more information. This is unrelated to policy darklaunch, which is controlled by `request_policy_rollout_enforcement_mode`. Merge logic is LOGICAL OR. type boolean isIncognito description Whether the request was made in incognito mode or not. See go/ptoken-policy-iga-incognito. Merge logic is logical OR. type boolean originAssociatedProductId description This is used to represent the Product in which the request originated. Merge logic is overwrite, aka "latest value wins". See go/origin-product-id-accessors and go/dma-stable-ids for more details. format int32 type integer originIsEndUser description Set automatically by systems receiving direct traffic from the end user. Defaults to false, meaning this rpc cannot be directly traced back to an end user request. When merging privacy request contexts, this value will be the result of a logical OR of the combined contexts. This is used for a number of policies, such as DMA 6(9), to identify requests originating from the user. For example, primary store attribution is based on this. See go/request-origin-id-dd for more details. type boolean originLogicalCloudLocation description The originating logical location of the request, used to make data residency / data locality policy enforcement decisions. When accessing data in storage, the originating location of a request can be compared against the stored data's location restriction to prevent operations that would not conform with the storage data's location restriction. As per go/drz-client-location-prc, the oneof structure is approved by the owners of the Data Residency Handling Technical Roadmap Report (go/trr:dataresidency-handling) as a means of allowing this property to be extended to support other forms of logical locations. See go/drz-privacy-context-proposal and go/ptoken-policy-location-restriction. Merge logic is overwrite, aka "latest value wins". enum CLOUD_DATA_RESIDENCY_LOCATION_UNSPECIFIED AFRICA_SOUTH1 ASIA_EAST1 ASIA_EAST2 ASIA_NORTHEAST1 ASIA_NORTHEAST2 ASIA_NORTHEAST3 ASIA_SOUTH1 ASIA_SOUTH2 ASIA_SOUTHEAST1 ASIA_SOUTHEAST2 AU AUSTRALIA_SOUTHEAST1 AUSTRALIA_SOUTHEAST2 CA DE EU EUROPE_CENTRAL2 EUROPE_NORTH1 EUROPE_NORTH2 EUROPE_SOUTHWEST1 EUROPE_WEST1 EUROPE_WEST10 EUROPE_WEST11 EUROPE_WEST12 EUROPE_WEST13 EUROPE_WEST14 EUROPE_WEST2 EUROPE_WEST3 EUROPE_WEST4 EUROPE_WEST5 EUROPE_WEST6 EUROPE_WEST7 EUROPE_WEST8 EUROPE_WEST9 GLOBAL INDIA IT JP ME_CENTRAL1 ME_CENTRAL2 ME_WEST1 NORTHAMERICA_NORTHEAST1 NORTHAMERICA_NORTHEAST2 PROD_AE_FJR_1 PROD_AR_EZE_1 PROD_AU_MEL_1 PROD_AU_SYD_1 PROD_BE_BRU_1 PROD_BG_SOF_1 PROD_BR_GRU_1 PROD_BR_RIO_1 PROD_CA_YUL_1 PROD_CA_YYZ_1 PROD_CH_ZRH_1 PROD_CL_SCL_1 PROD_CO_BOG_1 PROD_CZ_PRG_1 PROD_DE_BER_1 PROD_DE_FRA_1 PROD_DE_HAM_1 PROD_DE_MUC_1 PROD_DK_BLL_1 PROD_ES_MAD_1 PROD_FI_HEM_1 PROD_FI_LPP_1 PROD_FR_LBG_1 PROD_FR_MRS_1 PROD_FR_PAR_1 PROD_GB_LHR_1 PROD_HK_HKG_1 PROD_HU_BUD_1 PROD_ID_CGK_1 PROD_IE_DUB_1 PROD_IL_TLV_1 PROD_IN_BOM_1 PROD_IN_DEL_1 PROD_IN_MAA_1 PROD_IT_MIL_1 PROD_IT_TRN_1 PROD_JP_KIX_1 PROD_JP_NRT_1 PROD_KE_MBA_1 PROD_KR_ICN_1 PROD_MX_QRO_1 PROD_MY_KUL_1 PROD_NG_LOS_1 PROD_NL_AMS_1 PROD_NL_DHR_1 PROD_NL_GRQ_1 PROD_OM_MCT_1 PROD_PH_MNL_1 PROD_PL_WAW_1 PROD_PT_LIS_1 PROD_QA_DIA_1 PROD_RU_LED_1 PROD_RU_SVO_1 PROD_SA_DMM_1 PROD_SE_ARN_1 PROD_SG_SIN_1 PROD_TH_BKK_1 PROD_TW_TPE_1 PROD_TW_TSA_1 PROD_UA_KBP_1 PROD_US_ATL_1 PROD_US_CBF_1 PROD_US_CHS_1 PROD_US_CKV_1 PROD_US_CMH_1 PROD_US_DEN_1 PROD_US_DFW_1 PROD_US_DLS_1 PROD_US_IAD_1 PROD_US_LAS_1 PROD_US_LAX_1 PROD_US_LGA_1 PROD_US_MIA_1 PROD_US_MRN_1 PROD_US_ORD_1 PROD_US_PHX_1 PROD_US_RNO_1 PROD_US_SEA_1 PROD_US_SFO_1 PROD_US_SLC_1 PROD_US_TUL_1 PROD_US_UOS_1 PROD_UY_MVD_1 PROD_ZA_JNB_1 SA SOUTHAMERICA_EAST1 SOUTHAMERICA_WEST1 US US_CENTRAL1 US_CENTRAL1GOOGLE US_CENTRAL2 US_CENTRAL3 US_CENTRAL4 US_CENTRAL5 US_EAST1 US_EAST2 US_EAST3 US_EAST4 US_EAST5 US_EAST7 US_EAST8 US_EAST9 US_SOUTH1 US_WEST1 US_WEST2 US_WEST3 US_WEST4 US_WEST5 US_WEST6 US_WEST7 US_WEST8 AR_ASIA AR_EUROPE AR_US ASIA ASIA1 ASIA2 ASIA_PRIVATE1 BQ_ASIA BQ_EU BQ_US CHC_EU CHC_PREPROD_US CHC_US CLOUD_VISION_EU CLOUD_VISION_US CSTT_EUROPE CSTT_US CTTS_EUROPE CTTS_US DIALOGFLOW_CX_US DLP_ASIA DLP_EUROPE DLP_US DOC_AI_EU DOC_AI_US EUR3 EUR4 EUR5 EUR6 EUR7 EUR8 EUROPE_WEST EUR_NAM1 EUR_PRIVATE1 EVENTARC_ASIA EVENTARC_ASIA1 EVENTARC_EU EVENTARC_EUR3 EVENTARC_EUR4 EVENTARC_NAM4 EVENTARC_NAM5 EVENTARC_US GCE_ASIA GCE_EU GCE_US GCF_ASIA GCF_EUROPE GCF_NON_AXT_ASIA GCF_NON_AXT_EUROPE GCF_NON_AXT_US GCF_US GCS_ASIA GCS_ASIA1 GCS_ASIA_EUROPE_NORTHAMERICA GCS_EU GCS_EUR4 GCS_NAM4 GCS_SOUTHAMERICA GCS_US IP_US KMS_ASIA KMS_ASIA1 KMS_EUR3 KMS_EUR4 KMS_EUR5 KMS_EUR6 KMS_EUR7 KMS_NAM10 KMS_NAM11 KMS_NAM12 KMS_NAM3 KMS_NAM4 KMS_NAM6 KMS_NAM7 KMS_NAM8 KMS_NAM9 KMS_NAM_EUR_ASIA1 NAM10 NAM11 NAM12 NAM13 NAM14 NAM15 NAM2 NAM3 NAM3_LARGE NAM4 NAM5 NAM6 NAM7 NAM8 NAM9 NAM_EUR_ASIA1 NAM_EUR_ASIA2 NAM_EUR_ASIA3 NAM_PRIVATE1 NAM_PRIVATE2 NAM_PRIVATE3 PD_ASIA PD_EU PD_US US_CENTRAL PROD_AE_DXB_1 PROD_AU_BNE_1 PROD_AU_CBR_1 PROD_DE_DUS_1 PROD_DK_CPH_1 PROD_ES_BCN_1 PROD_US_AUS_1 PROD_US_BOS_1 PROD_US_PDX_1 PROD_ZA_CPT_1 PROD_AT_VIE_1 PROD_AU_PER_1 PROD_CA_YVR_1 PROD_CA_YYC_1 PROD_GB_MAN_1 PROD_IN_HYD_1 PROD_JP_NGO_1 PROD_NO_OSL_1 PROD_RO_OTP_1 PROD_US_HOU_1 PROD_US_MCI_1 PROD_US_PHL_1 PROD_US_RDU_1 PROD_US_ROA_1 PROD_US_SAT_1 NORTHAMERICA_SOUTH1 BR CH CL GB ID IL KR PROD_US_FWA_1 SG TW US_EAST10 ASIA_SOUTHEAST3 PROD_US_GUM_1 PROD_DE_HDF_1 EUROPE_NORTH3 EVENTARC_NAM7 PROD_NZ_AKL_1 PROD_US_LNK_1 PROD_GR_ATH_1 PROD_NO_SKE_1 enumDescriptions type string pafEnforcedReturnPolicies description This represents the list of policies that clients' business logic will enforce on the data return path. When a policy is present in this field, pToken engine in the downstream stack will skip its evaluation. It is caller's own responsibility to ensure that the policy is enforced. Merge logic is UNION. See go/dma52-filtering-exception for more details about PAF and how to request PAF approval. items enum UNSPECIFIED AADC_GUEST_LOGGING ADP_ANNOTATION ADS_KIDS ADS_P13N AIPEX_PERSONALIZED_DATA ASSISTANT_GEMINI ASSISTANT_GUEST_RESTRICTIONS AXT_STORAGE_COMPLIANCE CLOUD_LOCATION_RESTRICTION DMA52 FLOGS_SOFT_DELETE FOOTPRINTS_SIGNED_OUT_RESTRICTIONS GCS_POLICY GEO_DATA_INTEGRITY K12_MONETIZATION_PROHIBITION NEED_TO_KNOW_POLICY NO_ADS_ACCESS OLYMPUS OPT_IN_PURPOSE_CONSENT PAYMENTS_PERSONALIZATION_SETTINGS PHOTOS_MINORS_MONETIZATION_PROHIBITION PLX_NO_BROAD_WRITABLE PRODUCT_ASSOCIATION_RESTRICTION SALSA_CRITICAL_STOPGAP_LOG_DELETION SEARCH_ANALYTICS_3P_MEDIA SEARCH_MODEL_TRAINING_PRIVACY_CONTROL SEARCH_SIGNED_OUT_RESTRICTIONS UNICORN_MONETIZATION_PROHIBITION USER_PERSONALIZATION_SETTINGS WORKSPACE_PROCESSING_USER_CONSENT_SETTINGS YOUTUBE_CHILDREN_EDU enumDescriptions Handling AADC guest logging. Adp annotation policy. Ads Kids specific restrictions on data excluding DMA. Ads personalization specific restrictions on data defined in go/ptoken-policy-ads-p13n AIPEX personalized data policy. go/ptoken-aipex-personalized-data Assistant Gemini (previously Bard) specific restrictions on data. Logical policies defined in go/pazl-aadc-ptoken-analysis. Axt Storage Compliance policies restrictions. Cloud Data Residency location restrictions on GCP in-scope end-user data. Article 5(2) of the DMA (go/dma52). Flogs soft delete policy. go/ptoken-flogs-soft-delete-policy Footprints specific restrictions on guest data. GCS Policies. Geo data integrity policy. Monetization related restrictions of use of Dasher's children's (K-12) data. Need to Know policy (processing) Handling No Ads Access requests. go/olympus storage and processing regionalization. Opt-in purpose consent policy. Payments related restrictions based on privacy settings Photos specific limitations on monetization per user minors (users under 18) Plx No Broad Writable policy. Manually-configured restriction on dataset product association. SALSA critical stopgap log deletion policy go/ptoken-stopgap-deletion-policy. Search Analytics 3P Media policy. Search Model Training Privacy Control policy. go/ptoken-dga-smpc Search specific restrictions on signed out users. Monetization related restrictions of use of Dasher's children's (unicorn) data. General user related restrictions based on privacy settings. Workspace processing user consent settings. go/eecc-v2-ptoken-policy Handling Wipeout of YouTube Gaia Data for Edunitube. type string type array poeEnforcedReturnPolicies description This represents the list of policies that a layer in the upstream stack promises to enforce on the data return path to its client. This is mostly about post-read filtering of data, either when returning data or when forwarding it further. When a policy is present in this field, pToken engine in the downstream stack can skip its evaluation. Note on usage: an upstream system should add a promise for a policy only if it also performs the necessary enforcement steps. Merge logic is UNION. See go/promise-of-enforcement for the design. items enum UNSPECIFIED AADC_GUEST_LOGGING ADP_ANNOTATION ADS_KIDS ADS_P13N AIPEX_PERSONALIZED_DATA ASSISTANT_GEMINI ASSISTANT_GUEST_RESTRICTIONS AXT_STORAGE_COMPLIANCE CLOUD_LOCATION_RESTRICTION DMA52 FLOGS_SOFT_DELETE FOOTPRINTS_SIGNED_OUT_RESTRICTIONS GCS_POLICY GEO_DATA_INTEGRITY K12_MONETIZATION_PROHIBITION NEED_TO_KNOW_POLICY NO_ADS_ACCESS OLYMPUS OPT_IN_PURPOSE_CONSENT PAYMENTS_PERSONALIZATION_SETTINGS PHOTOS_MINORS_MONETIZATION_PROHIBITION PLX_NO_BROAD_WRITABLE PRODUCT_ASSOCIATION_RESTRICTION SALSA_CRITICAL_STOPGAP_LOG_DELETION SEARCH_ANALYTICS_3P_MEDIA SEARCH_MODEL_TRAINING_PRIVACY_CONTROL SEARCH_SIGNED_OUT_RESTRICTIONS UNICORN_MONETIZATION_PROHIBITION USER_PERSONALIZATION_SETTINGS WORKSPACE_PROCESSING_USER_CONSENT_SETTINGS YOUTUBE_CHILDREN_EDU enumDescriptions Handling AADC guest logging. Adp annotation policy. Ads Kids specific restrictions on data excluding DMA. Ads personalization specific restrictions on data defined in go/ptoken-policy-ads-p13n AIPEX personalized data policy. go/ptoken-aipex-personalized-data Assistant Gemini (previously Bard) specific restrictions on data. Logical policies defined in go/pazl-aadc-ptoken-analysis. Axt Storage Compliance policies restrictions. Cloud Data Residency location restrictions on GCP in-scope end-user data. Article 5(2) of the DMA (go/dma52). Flogs soft delete policy. go/ptoken-flogs-soft-delete-policy Footprints specific restrictions on guest data. GCS Policies. Geo data integrity policy. Monetization related restrictions of use of Dasher's children's (K-12) data. Need to Know policy (processing) Handling No Ads Access requests. go/olympus storage and processing regionalization. Opt-in purpose consent policy. Payments related restrictions based on privacy settings Photos specific limitations on monetization per user minors (users under 18) Plx No Broad Writable policy. Manually-configured restriction on dataset product association. SALSA critical stopgap log deletion policy go/ptoken-stopgap-deletion-policy. Search Analytics 3P Media policy. Search Model Training Privacy Control policy. go/ptoken-dga-smpc Search specific restrictions on signed out users. Monetization related restrictions of use of Dasher's children's (unicorn) data. General user related restrictions based on privacy settings. Workspace processing user consent settings. go/eecc-v2-ptoken-policy Handling Wipeout of YouTube Gaia Data for Edunitube. type string type array policiesBreakglass description Send breakglass signal for a given policy. Evaluation for policies in "breakglass" status will be DISABLED. Breakglass can be set only with a valid justification, and its usage will be monitored for compliancy purposes. More details about breakglass, requirements to set it and how to do it in go/dma52-prc-breakglass. Note that breakglass is intended to be used only for emergencies when the policy is in LAUNCHED state. For opting out while the policy is in ONGOING_ROLLOUT, see `request_policy_rollout_enforcement_mode`. Merge logic for this field is union set. items enum UNSPECIFIED AADC_GUEST_LOGGING ADP_ANNOTATION ADS_KIDS ADS_P13N AIPEX_PERSONALIZED_DATA ASSISTANT_GEMINI ASSISTANT_GUEST_RESTRICTIONS AXT_STORAGE_COMPLIANCE CLOUD_LOCATION_RESTRICTION DMA52 FLOGS_SOFT_DELETE FOOTPRINTS_SIGNED_OUT_RESTRICTIONS GCS_POLICY GEO_DATA_INTEGRITY K12_MONETIZATION_PROHIBITION NEED_TO_KNOW_POLICY NO_ADS_ACCESS OLYMPUS OPT_IN_PURPOSE_CONSENT PAYMENTS_PERSONALIZATION_SETTINGS PHOTOS_MINORS_MONETIZATION_PROHIBITION PLX_NO_BROAD_WRITABLE PRODUCT_ASSOCIATION_RESTRICTION SALSA_CRITICAL_STOPGAP_LOG_DELETION SEARCH_ANALYTICS_3P_MEDIA SEARCH_MODEL_TRAINING_PRIVACY_CONTROL SEARCH_SIGNED_OUT_RESTRICTIONS UNICORN_MONETIZATION_PROHIBITION USER_PERSONALIZATION_SETTINGS WORKSPACE_PROCESSING_USER_CONSENT_SETTINGS YOUTUBE_CHILDREN_EDU enumDescriptions Handling AADC guest logging. Adp annotation policy. Ads Kids specific restrictions on data excluding DMA. Ads personalization specific restrictions on data defined in go/ptoken-policy-ads-p13n AIPEX personalized data policy. go/ptoken-aipex-personalized-data Assistant Gemini (previously Bard) specific restrictions on data. Logical policies defined in go/pazl-aadc-ptoken-analysis. Axt Storage Compliance policies restrictions. Cloud Data Residency location restrictions on GCP in-scope end-user data. Article 5(2) of the DMA (go/dma52). Flogs soft delete policy. go/ptoken-flogs-soft-delete-policy Footprints specific restrictions on guest data. GCS Policies. Geo data integrity policy. Monetization related restrictions of use of Dasher's children's (K-12) data. Need to Know policy (processing) Handling No Ads Access requests. go/olympus storage and processing regionalization. Opt-in purpose consent policy. Payments related restrictions based on privacy settings Photos specific limitations on monetization per user minors (users under 18) Plx No Broad Writable policy. Manually-configured restriction on dataset product association. SALSA critical stopgap log deletion policy go/ptoken-stopgap-deletion-policy. Search Analytics 3P Media policy. Search Model Training Privacy Control policy. go/ptoken-dga-smpc Search specific restrictions on signed out users. Monetization related restrictions of use of Dasher's children's (unicorn) data. General user related restrictions based on privacy settings. Workspace processing user consent settings. go/eecc-v2-ptoken-policy Handling Wipeout of YouTube Gaia Data for Edunitube. type string type array policiesBreakglassStillEvaluated description Turns on evaluation for a policy in breakglass status. This policy will be evaluated in DARK_LAUNCHED mode, i.e. it will be evaluated and monitored, but the result will not affect enforcement. More details at go/ptoken-breakglass-monitoring. This field has no effect for policies that do not also set the breakglass signal (see `policies_breakglass`). Merge logic is union set. items enum UNSPECIFIED AADC_GUEST_LOGGING ADP_ANNOTATION ADS_KIDS ADS_P13N AIPEX_PERSONALIZED_DATA ASSISTANT_GEMINI ASSISTANT_GUEST_RESTRICTIONS AXT_STORAGE_COMPLIANCE CLOUD_LOCATION_RESTRICTION DMA52 FLOGS_SOFT_DELETE FOOTPRINTS_SIGNED_OUT_RESTRICTIONS GCS_POLICY GEO_DATA_INTEGRITY K12_MONETIZATION_PROHIBITION NEED_TO_KNOW_POLICY NO_ADS_ACCESS OLYMPUS OPT_IN_PURPOSE_CONSENT PAYMENTS_PERSONALIZATION_SETTINGS PHOTOS_MINORS_MONETIZATION_PROHIBITION PLX_NO_BROAD_WRITABLE PRODUCT_ASSOCIATION_RESTRICTION SALSA_CRITICAL_STOPGAP_LOG_DELETION SEARCH_ANALYTICS_3P_MEDIA SEARCH_MODEL_TRAINING_PRIVACY_CONTROL SEARCH_SIGNED_OUT_RESTRICTIONS UNICORN_MONETIZATION_PROHIBITION USER_PERSONALIZATION_SETTINGS WORKSPACE_PROCESSING_USER_CONSENT_SETTINGS YOUTUBE_CHILDREN_EDU enumDescriptions Handling AADC guest logging. Adp annotation policy. Ads Kids specific restrictions on data excluding DMA. Ads personalization specific restrictions on data defined in go/ptoken-policy-ads-p13n AIPEX personalized data policy. go/ptoken-aipex-personalized-data Assistant Gemini (previously Bard) specific restrictions on data. Logical policies defined in go/pazl-aadc-ptoken-analysis. Axt Storage Compliance policies restrictions. Cloud Data Residency location restrictions on GCP in-scope end-user data. Article 5(2) of the DMA (go/dma52). Flogs soft delete policy. go/ptoken-flogs-soft-delete-policy Footprints specific restrictions on guest data. GCS Policies. Geo data integrity policy. Monetization related restrictions of use of Dasher's children's (K-12) data. Need to Know policy (processing) Handling No Ads Access requests. go/olympus storage and processing regionalization. Opt-in purpose consent policy. Payments related restrictions based on privacy settings Photos specific limitations on monetization per user minors (users under 18) Plx No Broad Writable policy. Manually-configured restriction on dataset product association. SALSA critical stopgap log deletion policy go/ptoken-stopgap-deletion-policy. Search Analytics 3P Media policy. Search Model Training Privacy Control policy. go/ptoken-dga-smpc Search specific restrictions on signed out users. Monetization related restrictions of use of Dasher's children's (unicorn) data. General user related restrictions based on privacy settings. Workspace processing user consent settings. go/eecc-v2-ptoken-policy Handling Wipeout of YouTube Gaia Data for Edunitube. type string type array privacyAttributesSetter $ref PrivacyAttributesSetter description The privacy attributes setter contains a hashed representation of the job that have set the latest attributes (e.g. Product ID) in the currentrequest context. More at http://go/privacy-attributes-setters processingPurpose description The actual purpose(s) for which processing is happening. Value & enum copied from ProcessingPurpose proto. Merge logic is take the entire new processing_purpose if present. items enum PROCESSING_PURPOSE_UNSPECIFIED PROCESSING_PURPOSE_NOTHING PROVISION_OF_SERVICE PROVISION_OF_SERVICE_INFRASTRUCTURE ADS_RELATED_PROVISION_OF_SERVICE PRODUCT_PERSONALIZATION CONTEXTUALIZATION REVENUE_GENERATION USER_SUPPORT CLOUD_PROCESSING_INFRASTRUCTURE ACCOUNT_MANAGEMENT USER_COMMUNICATIONS MODEL_TRAINING VERIFICATION_TESTING_VALIDATION DEBUGGING_AND_MONITORING INFRASTRUCTURE_METRICS DATA_RECOVERY BUSINESS_ANALYSIS MARKET_RESEARCH RESEARCH_EXPERIMENTATION TRUST_SAFETY TRUST_SAFETY_ANTI_FRAUD TRUST_SAFETY_ANTI_SPAM TRUST_SAFETY_SECURITY TRUST_SAFETY_ANTI_ABUSE COMPLIANCE_LEGAL_SUPPORT LIMITED_MANUAL_ACCESS COMPLIANCE_LEGAL_SUPPORT_TAKEOUT COMPLIANCE_LEGAL_SUPPORT_TAKEOUT_LEGAL COMPLIANCE_LEGAL_SUPPORT_TAKEOUT_CONSUMER COMPLIANCE_LEGAL_SUPPORT_ELI enumDeprecated False False False False False False False False False False False False False False False False False False False False False False True False False False False False False False False enumDescriptions The processing purpose is unset Data is being processed as part of normal provision of service. Provision of service is in general anything done with user consent, that is visible for the user or impacts the user. DO NOT USE this value for any processing that is used to provide advertising or other revenue generating features specifically related to advertising Data is being accessed as part of normal provision of a multi-tenant infrastructure (e.g., a storage system). Data is being processed to provide advertising or other revenue generation features specifically related to advertising Data is being processed to provide personalization features. Data is being processed to provide contextualization features, excluding ad-related contextualization. Data is being processed to drive revenue that is not related to ads (service related revenue). This category is for any data access that was caused by, pursuant to, or necessary to resolve an interaction with a customer or user that the customer initiated. This processing purpose is configured automatically for applicable requests flowing through GCP infrastructure. Data is processed through Cloud infrastructure that exclusively acts on user instruction. This infrastructure only serves Business Users. Data is being processed to handle a user request to manage their account. Data is being processed to send communications to users. Model training as a processing purpose was introduced for complying with the Search Model training Privacy Control (SMPC) policy: go/smpc-program, go/ptoken-dga-smpc. While this purpose doesn't really represent an end-goal, it was approved by legal and reg affairs and its naming aligns with external conversations and regulatory interest. For questions about this purpose contact pCounsel who/sjz. Processing for debugging or monitoring or somehow related to pure software functionality. Access in order to perform testing, verification, certification, or other routine or pre-launch analysis by using stored user data. This can include regression testing, load testing, unit/integration testing, or other analysis of machine-generated or replayed activity. This is done primarily for routinized, transient evaluation like testing new builds/deployments. Processing for debugging or monitoring or somehow related to pure software functionality - analyzing user data to develop approved features, refactor or improve existing ones, or verify, triage, analyze, troubleshoot, or resolve problems with products and services Any processing for the purpose of understanding how services / products are used by users, including traffic shaping, monitoring etc. Any processing necessary to monitor a service and its performance to maintain product excellence, reliability, service quality, or other technical measures as perceived by a user. The data is being processed to detect, prevent, recover for data loss or corruption (in line with the purpose limitations documented at go/backups-user-data). See also go/dg-classification-backup-data. Perform analysis to set strategy, prioritize features, assess business risks or otherwise use the data to derive insights for the benefits of the company or its product or service offering. This is for any analysis that looks at the existing market across companies / manufacturers, or generates leads, contacts or potential clients or users. This can be either for manual outreach, automatic outreach or internal use. Open-ended or undirected analysis of user data with a clear hypothesis or intended benefit in mind. The data is being processed to protect Google, its users, customers or other stakeholders. This includes manual detection, analysis, remediation, prevention of unacceptable abusive behavior as defined by the terms of service. It also includes actions such as processing to keep accounts safe (such as processing for the purposes of auth or authz) More specific Trust and safety purposes. Processing the data for compliance purposes, legal purpose, law enforcement requests and incident management related to any of these. type string type array requestPolicyEnforcement deprecated True description Requests that a given policy be hard enforced if possible, even when they would not normally be. For example, a policy that's in ONGOING_ROLLOUT mode would perform hard enforcement when present in the list. This is generally set on OTA accounts to permit early testing. items enum UNSPECIFIED AADC_GUEST_LOGGING ADP_ANNOTATION ADS_KIDS ADS_P13N AIPEX_PERSONALIZED_DATA ASSISTANT_GEMINI ASSISTANT_GUEST_RESTRICTIONS AXT_STORAGE_COMPLIANCE CLOUD_LOCATION_RESTRICTION DMA52 FLOGS_SOFT_DELETE FOOTPRINTS_SIGNED_OUT_RESTRICTIONS GCS_POLICY GEO_DATA_INTEGRITY K12_MONETIZATION_PROHIBITION NEED_TO_KNOW_POLICY NO_ADS_ACCESS OLYMPUS OPT_IN_PURPOSE_CONSENT PAYMENTS_PERSONALIZATION_SETTINGS PHOTOS_MINORS_MONETIZATION_PROHIBITION PLX_NO_BROAD_WRITABLE PRODUCT_ASSOCIATION_RESTRICTION SALSA_CRITICAL_STOPGAP_LOG_DELETION SEARCH_ANALYTICS_3P_MEDIA SEARCH_MODEL_TRAINING_PRIVACY_CONTROL SEARCH_SIGNED_OUT_RESTRICTIONS UNICORN_MONETIZATION_PROHIBITION USER_PERSONALIZATION_SETTINGS WORKSPACE_PROCESSING_USER_CONSENT_SETTINGS YOUTUBE_CHILDREN_EDU enumDescriptions Handling AADC guest logging. Adp annotation policy. Ads Kids specific restrictions on data excluding DMA. Ads personalization specific restrictions on data defined in go/ptoken-policy-ads-p13n AIPEX personalized data policy. go/ptoken-aipex-personalized-data Assistant Gemini (previously Bard) specific restrictions on data. Logical policies defined in go/pazl-aadc-ptoken-analysis. Axt Storage Compliance policies restrictions. Cloud Data Residency location restrictions on GCP in-scope end-user data. Article 5(2) of the DMA (go/dma52). Flogs soft delete policy. go/ptoken-flogs-soft-delete-policy Footprints specific restrictions on guest data. GCS Policies. Geo data integrity policy. Monetization related restrictions of use of Dasher's children's (K-12) data. Need to Know policy (processing) Handling No Ads Access requests. go/olympus storage and processing regionalization. Opt-in purpose consent policy. Payments related restrictions based on privacy settings Photos specific limitations on monetization per user minors (users under 18) Plx No Broad Writable policy. Manually-configured restriction on dataset product association. SALSA critical stopgap log deletion policy go/ptoken-stopgap-deletion-policy. Search Analytics 3P Media policy. Search Model Training Privacy Control policy. go/ptoken-dga-smpc Search specific restrictions on signed out users. Monetization related restrictions of use of Dasher's children's (unicorn) data. General user related restrictions based on privacy settings. Workspace processing user consent settings. go/eecc-v2-ptoken-policy Handling Wipeout of YouTube Gaia Data for Edunitube. type string type array requestPolicyRolloutEnforcementMode description Requests a particular enforcement mode for a given policy. Uses a single enum to convey both to minimize payload size. Mapping to and from {LogicalPolicy, EnforcementMode} are provided in the getter and setter apis. Merge logic is union set. These modes only take effect while the policy is in ONGOING_ROLLOUT status. More details in go/dma52-prc-rollout-signals. items enum POLICY_ROLLOUT_ENFORCEMENT_MODE_UNSPECIFIED DMA52_GLOBAL_RAMPUP DMA52_EXPLICIT_OPT_IN DMA52_OPT_OUT DMA52_OPT_OUT_FILTERING DMA52_DISCOVERY_OPT_IN DMA52_WAVE3_EARLY_ENFORCEMENT DMA52_WAVE3_CLIENT_OPT_IN DMA52_WAVE3_INTERNAL_OPT_IN enumDescriptions Enables enforcement on DMA52 policy for systems/dataset that are in the ENFORCEABLE state (see google3/privacy/ptoken/contrib/policy_rollouts/request_context_enforceable_mode_config.proto). Set upstream centrally based on the user bucket (go/policy-rollout-buckets). It works only if the specific DMA 5(2) policy is loaded with ONGOING_ROLLOUT status (check status for your integration in google3/configs/privacy/ptoken/prod/clients/). No effect when policy is in LAUNCHED status. If a FractionalRolloutConfiguration (google3/privacy/ptoken/contrib/policy_rollouts/fractional_enforcement.proto) for DMA52 policy is provided, this signal is ignored. Enables enforcement on DMA52 policy for systems/dataset that are in the EARLY_ENFORCEABLE and ENFORCEABLE states (see google3/privacy/ptoken/contrib/policy_rollouts/request_context_enforceable_mode_config.proto) It works only if the specific DMA 5(2) policy is loaded with ONGOING_ROLLOUT status (check status for your integration in google3/configs/privacy/ptoken/prod/clients/). No effect when policy is in LAUNCHED status. To be set explicitly by callers. Turns off both hard enforcement and AOM for DMA52 policies. It works only if the specific DMA 5(2) policy is loaded with ONGOING_ROLLOUT status (check status for your integration in google3/configs/privacy/ptoken/prod/clients/). No effect when policy is in LAUNCHED status. Downgrades enforcement mode to AOM for DMA52 policies. If the policy is fully launched, or if AOM stage is not reached yet, this value will have no effect. It works only if the specific DMA 5(2) policy is loaded with ONGOING_ROLLOUT status (check status for your integration in google3/configs/privacy/ptoken/prod/clients/). No effect when policy is in LAUNCHED status. Enables enforcement for systems/datasets enabled in DISCOVERY_ENFORCEMENT to explicitly test outside of central control. It works only if the specific DMA 5(2) policy is loaded with ONGOING_ROLLOUT status (check status for your integration in google3/configs/privacy/ptoken/prod/clients/). No effect when policy is in LAUNCHED status. To be set explicitly by callers. Enables enforcement on the Wave 3 DMA 5(2) policy for systems/dataset that are in the EARLY_ENFORCEABLE and ENFORCEABLE states (see google3/privacy/ptoken/contrib/policy_rollouts/request_context_enforceable_mode_config.proto) It works only if the Wave 3 DMA 5(2) policy is loaded with ONGOING_ROLLOUT status (check status for your integration in google3/configs/privacy/ptoken/prod/clients/). No effect when policy is in LAUNCHED status. To be set explicitly by callers. NOTE: Currently, there is no way to set these two signals (DMA52_WAVE3_CLIENT_OPT_IN and DMA52_WAVE3_INTERNAL_OPT_IN). This is intentional, an API to set these will be added soon once the CLs that submitted the new signals are rollback safe. Used for PA experiments and PA-driven rampup. TODO (b/377510871): Make an API to set DMA52_WAVE3_CLIENT_OPT_IN and DMA52_WAVE3_INTERNAL_OPT_IN. Set by Consistent Enforcement API. type string type array searchIsInEmergencyCriticalOnlyMode description DO NOT ALTER THIS ATTRIBUTE STATE without reaching out to Footprints or Kansas teams. Captures whether Search (or more precisely GWS) is in critical-only mode, which is a production disaster mitigation state. This is supported as part of go/search-reliability-code-purple. In more details: controls whether or not non-critical data should be returned to search. When set, it indicates that all non-critical data should be filtered out (based on DGA). Used to mitigate and recover from search outages caused by non-essential data. Populated by a borg flag. See go/ptoken-policy-kansas-filter. Merge logic is logical OR. type boolean semanticPurpose description The semantic purpose of the request. See go/processing-purpose-v2 for details. enum SEMANTIC_PURPOSE_UNSPECIFIED SEMANTIC_PURPOSE_SERVICE_DELIVERY SEMANTIC_PURPOSE_LEGAL_OBLIGATION enumDescriptions The semantic purpose is unset To provide and maintain Google services, products and features. To protect Google, our users, and the public. type string signedOutEpdEligibility description Whether the user is eligible to receive Signed Out ePD treatment, to comply with the ePrivacy Directive (ePD). See go/ptoken-signed-out-epd-eligibility and proto definition for more details. Merge logic uses max value. enum EPD_ELIGIBILITY_UNSPECIFIED EPD_ELIGIBILITY_ELIGIBLE EPD_ELIGIBILITY_NOT_ELIGIBLE_REGION_OUT_OF_SCOPE EPD_ELIGIBILITY_NOT_ELIGIBLE_APPLICATION_OUT_OF_SCOPE EPD_ELIGIBILITY_NOT_ELIGIBLE_SIGNED_IN_OUT_OF_SCOPE enumDescriptions Default unspecified value. The request is in scope for ePD treatment. The request is not eligible for ePD treatment, because it originated from an out of scope country. The request is not eligible for ePD treatment, because the application marked it explicitly as out of scope. The request is not eligible for ePD treatment, because the user is signed-in. Signed-in users are currently always out of scope. type string userSignInState description A user's sign-in status. See go/signin-prc and proto definition for more details. Merge logic uses max value, to keep the request at the most restrictive state encountered. enum USER_SIGN_IN_STATE_UNSPECIFIED USER_SIGN_IN_STATE_SIGNED_OUT USER_SIGN_IN_STATE_SIGNED_IN enumDescriptions type string youtubeAutoplayEmbeddedPlayback description Whether or not this YouTube playback originated from the embedded player with autoplay enabled. Merge logic is LOGICAL OR. See go/youtube-privacy-enhanced-playbacks-ptoken-policy for more details. type boolean youtubePrivacyEnhancedPlayerType description The type of YouTube privacy enhanced player on which the playback occurred. Merge logic is overwrite, or "latest value wins". See go/youtube-privacy-enhanced-playbacks-ptoken-policy for more details. enum YOUTUBE_PRIVACY_ENHANCED_PLAYER_TYPE_UNSPECIFIED YOUTUBE_PRIVACY_ENHANCED_PLAYER_TYPE_PLAYER_FOR_EDUCATION YOUTUBE_PRIVACY_ENHANCED_PLAYER_TYPE_GOOGLE_WORKSPACE YOUTUBE_PRIVACY_ENHANCED_PLAYER_TYPE_PLAYER_FOR_PUBLISHERS YOUTUBE_PRIVACY_ENHANCED_PLAYER_TYPE_PLAYER_FOR_COMMENTS enumDescriptions type string type object PrivacyAttributesSetter description Encapsulates hash of the privacy-related attributes setters. See go/privacy-attributes-setters. Every new field should be prefixed with the nested field definition inside PrivacyContext proto. For example, PrivacyContext.prequest.origin_associated_product_id becomes *prequest_origin_associated_product_id*_setter_job id PrivacyAttributesSetter properties borgRunUid description The Borg Run UID of the job that sent the initial request. format int64 type string customExecutionId description A custom ID to differentiate a job or unit of execution, specified by user code or configuration. Right most 5 bits are used to encode the type of custom_execution_id which is defined by CustomExecutionIDType. For example, value of (58 bits of ID value)(0b00001) represents non borg job run id. format int64 type string passthroughGfeService description The hash of the GFE service name when having a non-positive origin_product_id value (considered as a passthrough case from GFE). Note that definition of passthrough here (all non-positive product ids) is different from the one in go/dma52-multi-tenant-gfe#what-is-a-passthrough-service (where product id is -1), but they are equivalent in GFE binary code, where we skip Product ID setting. The hash is calculated by keeping the most significant 4 bytes of Fingerprint2011. The service name is read by GFE from GFE config files. This field will be set by GFE jobs only to help downstream debugging. format uint32 type integer prequestOriginAssociatedProductIdSetterGfeService description The hash of the GFE service name setting the PRequestContext.origin_product_id. The hash is calculated by keeping the most significant 4 bytes of Fingerprint2011. GFE service name is set by GFE job while setting the Product ID. The service name is read by GFE from GFE config files. This field will be set by GFE jobs only. format uint32 type integer prequestOriginAssociatedProductIdSetterJob description The hash of the borgjob setting the PRequestContext.origin_product_id. The hash is calculated by keeping the most significant 4 bytes of Fingerprint2011. A borgjob is defined by the concatenation of borg_user, job_name and borg_cell_id. format uint32 type integer sourcePipelineGuri description The hash of a guri at the originator pipeline of the request. This is used for go/dma52-rm-processing and other use cases when the client guri is insufficient on its own (such as multi tanent systems). format uint32 type integer type object ProvidedData description Provided data which augments the device action capabilities. Some built-in intents may require additional configuration to be provided. One example could be the list of channels available for the `action.intent.SelectChannel` intent. id ProvidedData properties data additionalProperties description Properties of the object. Contains field @type with type URL. type any description For more details on which provided data types are available, see the individual intent documentations. type object name type string type object ResponseLimits description Size limits on responses. id ResponseLimits properties type object ResponseLoggingParams description Container for information that is used by the clients for per-response logging. This field can be filled by either Assistant Server or S3. Clients MUST NOT use this for any other purposes, such as branching on it. next id: 25 id ResponseLoggingParams properties designedForFamily description Whether or not logging should be handled as a defined_for_family feature. See go/a4k-logging for more details of the legal necessities. type boolean eventId description A unique ID used in Server side logging which can be used to coordinate Client actions to a particular Server response. type string featureVeId description VE ids of the triggered features, used mainly for testing purpose. items format int32 type integer type array firstFeatureVerticalName description The vertical which fulfilled the request. The vertical name comes from the Visual Element produced for this request. To avoid duplicating the VE list in AS and AGSA (and for privacy), we are sending only the vertical string name (instead of the Feature VEID). In case of multiple elements, the vertical comes from the first one produced. See go/opaft. type string followupQueryType description The type of followup query. enum FOLLOWUP_QUERY_TYPE_UNKNOWN FOLLOWUP_QUERY_TYPE_DISAMBIGUATION FOLLOWUP_QUERY_TYPE_FRAME_STATE_STEERING FOLLOWUP_QUERY_TYPE_SCREEN_CONTEXT_STEERING enumDescriptions type string isFollowupQuery description If a query is a followup to a previous query that returned a conversational response. type boolean isMasqueradeModeRequest description True if current request is fulfilled by a device in Masquerade mode (a privacy-improving incognito-style mode that limits logging and personalization -- see go/masquerade and go/masquerade-design for more details). This field is used by S3 to restrict logging to abuse-only. type boolean isOemPartner description True if current request comes from OEM device and is answered by OEM partners. If true, it should comply with 3P partner data policy. See go/assistant-sdk-partner-data for details. type boolean isSensitiveQuery description True if the original query contains sensitive data. Callers should not do archival logging in this case. See go/assistant-limited-logging and go/assistant-partner-sensitive-data for details. type boolean isUnintendedQuery description True if we deemed the query as unintended (go/unintended-suppression-dd). Bit is only set for suppression of logging and should not be used for other purposes (e.g. training). type boolean isYoutubeKidsNonManagedAccountRequest description True if current request involves fetching YouTube Kids content for non_managed_account (adult voice-matched or guests or Unicorn that didn’t set up the app for a dedicated experience), e.g. [play peppa pig on YouTube Kids]. If true logging of audio in S3 will not happen. go/ytk-logging for details. type boolean musicDisambiguationAnnotation $ref DisambiguationAnnotation description The disambiguation annotations from Sophia music dialog. See go/sophia-music-logging for details. requestContext $ref PRequestContext description Privacy context used for fulfilling of this request. responseErrorMessage description The additional error message when the response is not successful. type string responseIndex description Position of the given response among all responses of the request. Only set in the multiple responses flow. See http://go/assistant-multiple-response format int32 type integer responseReason enum UNKNOWN_RESPONSE_REASON SUCCESS ASSISTANT_SERVER_PUNT ASSISTANT_SERVER_TIME_OUT ASSISTANT_SERVER_NOT_REACHABLE ASSISTANT_SERVER_INTERNAL_ERROR MULTI_HOTWORD_ARBITRATION_REJECTED HOTWORD_MISTRIGGER BAD_REQUEST enumDescriptions Indicates the server was able to handle the request and the response is a successful response. Indicates the server was not capable to handle the request and the response is a punt response. The server timed out on handling the request. The server is not reachable at the moment. The server met internal error when handling the request. The server determined that the client is not selected in the multi-hotword arbitration. The server determined that the request is from a client whose hotword was mis-triggered. Catch-all category for what in HTTP would be a 400-class response code, and in AGSA might be termed "Not Google's Fault." That is, this response code indicates that we did not provide the user a satisfactory response, but do not regret that. HOTWORD_MISTRIGGER is an example of this category of error. This particular enum value is for requests that do not have any more-specific ResponseReason defined. type string serverHotwordInfo $ref ServerHotwordInfo serverSuppressionInfo $ref ServerSuppressionInfo description Additional details why we deemed the query as unintended. Only present if "is_unintended_query" is set to "true". sherlogUrl type string soundSearchHasNoResults description Whether a Sound Search returned no results. type boolean youtubeAssistantFeatureLog description Feature log for model training for YouTube Assistant. These features are be collected from backends like Superroot, passed to Voz InnerTube server via Voz Fulfillment server and Voz server, and logged to YouTubeGWSLogNewSession (processed_youtube.all.sessions). See go/ytm-voice-training-data-logging for detail. items $ref YouTubeAssistantFeatureLogEntry type array youtubeImpressions description Impressions for the youtube client to copy to YouTubeGWSLogEntryProto.Impression if applicable. Used by go/counterfactuals-for-voz for YouTube Assistant. items $ref YoutubeImpression type array youtubeMusicQueryInfo $ref MusicQueryInfo description Query intent logging for music. go/ytm-broad-query-experiments type object ResultInfo description The information about the result candidate. id ResultInfo properties musicTrackData $ref MusicTrackData type object RoutineCapability description Identifies whether or not a device model supports routines. id RoutineCapability properties supportsReconnect description Indicates that the client supports sequential execution of routines. type boolean type object SecurityConfig description Encapsulates security configuration for a single intent of a device model. id SecurityConfig properties authMechanismForRemoteRequests description Specifies auth mechanism to be used upon remote request for device action. enum NONE ENABLED FINGERPRINT_OR_PASSWORD PIN enumDeprecated False False True True enumDescriptions Indicates that auth is not required. Indicates that auth is required. Auth mechanism used is determined automatically at query time, based on various factors such as device type, user settings, etc. Use fingerprint, with fallback to Google account password if fingerprint capabilities are not available on personal device. Note: explicit configuration of specific auth mechanism is being deprecated. Prompt for pin, sent to cloud for validation. Note: explicit configuration of specific auth mechanism is being deprecated. type string type object ServerHotwordInfo description Add information about server hotword decision. Server Hotword enables decoding the full preamble+query audio in hotword triggered queries. By enabling decoding preamble+main audio, server hotword checks if a hotword phrase is detected in the top hypothesis. This signal may be used to suppress the request on client. While for most hotword triggered queries, server runs server_hotword, it's upto the client to use or ignore the signal when preparing the response. unintended_query_filter.gcl dictates for which clients server hotword is used to suppress the query or not. Even if server hotword result is not used to suppress, logging this information is useful for tracking the client hotword performance. Enum HOTWORD_MISTRIGGER ResponseReason above isn't currently used, but it is meant to set based on the action taken for the query. E.g. if the server_hotword doesn't find hotword, but client ignores the server hotword result, response_reason will not be set to HOTWORD_MISTRIGGER. (This is similar to HOTWORD_MISTRIGGER in ResponseForInvalidRequest - https://cs.corp.google.com/piper///depot/google3/assistant/api/conversation.proto?type=cs&q=+hotword_mistrigger&g=0&l=350&rcl=254451652 ) id ServerHotwordInfo properties result enum NOT_SET SERVER_HOTWORD_VALIDATED SERVER_HOTWORD_INVALIDATED enumDescriptions Hotword validation is not done in speech recognition server. Hotword was found by the speech recognition server. Hotword was not found by the speech recognition server. type string status enum UNKNOWN SERVER_HOTWORD_DISABLED SERVER_HOTWORD_ENABLED enumDescriptions Hotword validation is either not done or if done, is not used to suppress the query. It is the case when either unintended_query_filter or server_hotword check is not enabled. Defined at https://cs.corp.google.com/piper///depot/google3/googledata/experiments/assistant_server/features/unintended_query_filter.gcl?type=cs&g=0&l=18&rcl=248775811 Hotword validation is done on the speech recognition server AND the result is used to decide if the query should be suppressed or not. type string type object ServerSuppressionInfo description Contains additional information which of the existing server-side suppression mechanisms caused the query to be suppressed. Used for breaking down and logging client-side undertriggering. id ServerSuppressionInfo properties suppressedByHotword description Whether the query was suppressed because of the hotword invalidation signal. type boolean suppressedByLph description Whether the query was suppressed by the Long-Press-Home (LPH) filtering model. type boolean suppressedByPqrnnModel description Whether the query was suppressed by any of the existing semantic models (pQRNN, Ranklab, speech-aware model). type boolean suppressedByRanklabModel type boolean suppressedBySpeechAwareModel type boolean type object SignInMethod description The method of sign in which the client supports. id SignInMethod properties method enum UNSPECIFIED NOT_ALLOWED PHONE_APP ON_DEVICE_MENU WEB_APP enumDescriptions Unspecified value. Defaults to the same sign-in behavior as `PHONE_APP`. Sign in is not allowed. Sign in with Home app, e.g. Google Home. Sign in with on device menu, e.g. LGTV. Sign in with the Assistant sign in website. type string signInRequired description Make Google sign-in mandatory for using Google Assistant on the device. type boolean type object SliderProperties description All the information provided for the slider actions like max_level of slider or so. These will be used as markers to indicate slider properties and we do not issue command with param values beyond the limit. id SliderProperties properties maxValue description Max value of the slider levels that device understands. If it can only be set/unset and works like toggle then set this value to 1. format int32 type integer type object TimerCapability description Capability with regard to support of timers by the client. id TimerCapability properties maxSupportedTimers description Maximum number of timers that can be created on the client. Zero or unset indicates no maximum limit. format int32 type integer type object TraitConfig description Domain specific capabilities regarding traits. id TraitConfig properties attributes additionalProperties type any description The default attributes to be registered in this device for this trait. For example, `{"colorModel": "rgb"}` could designate the color model to use for the ColorSetting trait. The attributes will control the behavior of the traits, and different traits depend on different sets of attributes. The attributes for a specific device owned by the user may be overridden by the device instance registration. For the list of traits and their associated attributes, see https://developers.google.com/assistant/sdk/reference/traits/. type object type object VisualOutputCapability description Manages visual experience of the device model, including HTML related features. id VisualOutputCapability properties backButtonKeycode description The keyCode of the Back button on TV's remote control. format int32 type integer dimensions $ref Dimensions description Device dimensions. style description Specifies the visual output style for this device model. enum UNSPECIFIED HTML_TV TEXT CONCISE_TEXT enumDescriptions No visual experience is provided. Give visual output in HTML5 format, suitable for TV. Give plain text as output. Concise text responses that can be used, for example, on wearables with small screens. type string supportsPersistentDisplay description Identifies whether or not a device model supports a persistent display. type boolean supportsShowSuggestions description Enable suggestions as possible follow on queries generated by the Assistant. For example a user query of "what is weather today?" might generate a suggestion for "what about tomorrow?" or "how about this weekend?". If `VisualOutputCapability.Style.HTML_TV` is enabled, suggestions are already returned inside the HTML payload. If `supports_show_suggestions` is also set, the same suggestions will be returned outside the HTML payload. type boolean supportsWeatherDisplay description Identifies whether or not a device model supports displaying weather query results. type boolean usesSeparateFullViewer description If set, it indicates that the client needs to open a separate full viewer, e.g., a full HTML browser/webview, to handle visual results in `AssistResponse` with `viewer_type = FULL_VIEWER`, i.e., those require more resources to render or will trigger interactions that need full browser functions. If set, the Google Assistant backend may decide to return such visual results with content that better fit a full viewer, e.g., putting photos in full screen in the HTML markup. type boolean type object WifiCallingCapability description Identifies whether or not a device model has wifi calling capability. id WifiCallingCapability properties supportWifiCalling type boolean type object YouTubeAssistantFeatureLogEntry description Feature log for model training for YouTube voice queries. id YouTubeAssistantFeatureLogEntry properties tag description The string tag is used to distinguish logs from different systems. For example, "superroot top result model", "song ranking in mix server", etc. This field will be populated in Voz. items type string type array youtubeSuperrootQueryLevelFeatures $ref YouTubeSuperrootQueryLevelFeatures description Query level features. youtubeSuperrootResultLevelFeatures description One ResultLevelFeatures proto per result. The result does not have to be shown to the user. items $ref YouTubeSuperrootResultLevelFeatures type array type object YouTubeSuperrootQueryLevelFeatures description Next ID: 5 id YouTubeSuperrootQueryLevelFeatures properties hasMusicPremiumAccess description Whether the user has YouTube Music premium access. type boolean isEntitySeekingQuery description Whether the query is an entity seeking query (e.g. looking for a song). type boolean queryBroadnessScore description A score for how much the query is broad (instead of navigational). format float type number type object YouTubeSuperrootResultLevelFeatures description Next ID: 42 id YouTubeSuperrootResultLevelFeatures properties auisScoreQuery description AUIS (Assistant User Interaction Score) features of the (query, result) pair. There are multiple levels of granularities when getting AUIS feature for the request and result. Using (query, result) as key. format float type number auisScoreQueryLanguage description Using (query, language, result) as key. format float type number auisScoreQueryLanguageCountry description Using (query, language, country, result) as key. format float type number instantNavboostImpressions description See go/yt-instant-nb-g3doc for docs on YouTube Navboost/instant Navboost. format float type number instantNavboostTrad format float type number isEntityMatch description Whether there is an entity match between the query and document. type boolean isMusicOfficialContent description Whether the content is official (e.g. an official ATV). type boolean isMusicPaygatedContent description Whether the content is a paygated. type boolean isYoutubeMusicTopResult description YouTube Music only. Whether this result is the top result. This field will be populated in Voz. type boolean matchesAssistantIntentIsCollection description Whether the result type matches Assistant primary intent. "_is_collection" means we only distinguish whether the intent or result is a collection (playlist, album, artist) or a single video/ATV. "_type" means the type (video/ATV, playlist, album, artist). "_mid" means the mid associated with the result matches the mid in Assistant intent. type boolean matchesAssistantIntentMid type boolean matchesAssistantIntentType type boolean musicCombinedFeatureboostCpi description See go/featureboost-public for docs on YouTube Featureboost. YouTube Music "Combined Featureboost" means we attribute user activities on the top result to the original shelf they originally come from. This solves some oscillating problem of original Featureboost values. This is shelf Featureboost, not result level. format float type number musicCombinedFeatureboostDvq format float type number musicCombinedFeatureboostNumWatches format float type number musicCombinedFeatureboostRdp format float type number musicIrNoP13n description IR (information retrieval) score for the document. We will multiply some personalized factor to the IR score in Twiddler. "no_p13n" means the IR score without this tweak. format float type number musicResultType description Result type, e.g. SONG, VIDEO, PLAYLIST. See google3/video/youtube/search/alexandria/proto/youtube_music_info.proto type string navboostImpressionFrac format float type number navboostImpressions format float type number navboostLccFrac format float type number navboostTrad format float type number p13nArtistScore description P13n signals. Some of them are produced by other models. format float type number p13nCtr format float type number p13nCwt format float type number p13nLogEwt format float type number p13nPlaylistListenCount format int32 type integer p13nWatches format int32 type integer queryMatchTitleRatio description If title contains query, the ratio of query length / title length. Else 0. For example, if query = "Adele" and title = "Adele - Rolling in the Deep (Official Music Video)", then this feature is 1 / 8. format float type number topResultModelScore description The score of the result as determined by the top result model. format float type number tstar description go/tstar. Roughly a relevance score of the document and the query. format float type number url description The URL of the result. Contains video ID (if there) and playlist ID (if there). This field will be populated in Voz. type string watchboostCpi description See go/watchboost for information on YouTube Watchboost. Contains aggregated engagement information for videos. format float type number watchboostDvq format float type number watchboostImpressions format float type number watchboostNumClicks format float type number watchboostRdp format float type number youtubeDurationInSeconds description Length of the video. format int32 type integer youtubeMusicTopResultTriggerLogic description The final selection logic for the top result. There are results not selected by the model. enum TOP_RESULT_TRIGGER_LOGIC_UNKNOWN ALLOWLIST MY_MIX PRESELECT_HIGH_DVQ ARTIST_MIX_INTENT GENRE_MIX_MATCH_GENRE_QUERY PLAYLIST_HIGH_DVQ QUERY_MIX_MATCH_GENRE_QUERY_OR_KEY_WORDS TWIDDLER_ANNOTATION QUERY_SIGNAL FALLBACK_DOC_TRUST PRESELECT_PMV_LOW_DVQ GENRE_MIX_NOT_MATCH_GENRE_QUERY QUERY_MIX_NOT_MATCH_CONDITIONS PLAYLIST_LOW_DVQ FALLBACK_DVQ FALLBACK_IR_SCORE ARTIST_SWAP_TO_STATION CURATED_PLAYLIST SWAP_VIDEO_WITH_ATV TOPICAL_MIX HIGH_QUALITY_NEW_ALBUM ASSISTANT_SIGNAL BROAD_VOICE_PLAYLIST MODEL_BASED_SCORE LISTENED_PLAYLIST LIKED_SONGS_PLAYLIST ATTRIBUTE_RADIO ASSISTANT_INTENT_TYPE_TOP_RESULT_MODEL FALLBACK_ALBUM RANKED_RADIO ATV_VERSION_SWAP ASSISTANT_EXPLICIT_INTENT_TYPE MODEL_BASED_SCORE_RANDOMIZATION HEURISTIC_PODCAST_SHOW_USING_SHOW_ENTITY ALBUM_QUERY_TOP_RESULT_MODEL RECAP_PLAYLIST TRIGGERING_WORDS_PODCAST_SHOW_HEURISTIC QUS_PODCAST_SHOW_HEURISTIC EPISODES_PODCAST_SHOW_HEURISTIC YTKS_PODCAST_SHOW_HEURISTIC OFFLINE_LLM_RESPONSE ARTIST_QUERY_TOP_RESULT_MODEL SELECTED_EPISODE_VIDEO_FROM_SHOW enumDeprecated False False False False False False False False False False False False False False False False False False False False False False False True False False False False False False False False False False False False False False False False False False False False enumDescriptions Top result isn't setted. Top result is selected from allowlist. Play some music use case. Top result is selected from a pre-check on PMV using a high_threshold dvq. Top result is selected based on artist mix intent. Top result is selected from genre mix matching genre query mid. Top result is selected from playlist with a high_threshold dvq. Top result is selected from query mix matching genre query mid or query contains mix triggering keywords. Top result is selected from a twiddler annotated result, e.g. latest twiddler. Top result is selected based on query signals. Top result is selected using trust based fallback. Top result is selected from a pre-check on PMV using a low_threshold dvq. Top result is selected from genre mix without match conditions. Top result is selected from query mix without match conditions. Top result is selected from a low-threshold dvq check on playlists. Top result is selected using highest dvq within response. Top result is selected based on highest IR score within response. Top result selected based on Curated station presence for genre/query intent. Prefer ATV matching the video if the video is the top result and there exist a linked atv. Top result selected from topical mix Top result is selected from predicted high quality new album. Top result selected based on Assistant signals. Top result is a randomized playlist chosen for broad voice queries. Top result selected based on ranking results from various shelf directly. Top result based on user listened playlist. Top result selected from Liked Songs Playlist. Top result selected from Attribute Radio. Top result selected with top result model from content types matching Assistant intent type. Top result album fallback if no other album is selected. To result selection from the ranked radios/mixes Swap ATV to a better version, e.g. non canonical version swapped to studio version. Top result selected based on explicit intent type in Assistant intent. E.g. the user explicitly said the word "album" in the query. Top Result selected randomly from top N results based on top result model. Top result is selected using kg mid corresponding to a KG podcast show For album queries, top result will be selected from albums only using Top Result Model. Top result selected from Recap Playlist. A podcast show is promoted for queries with specific triggering words (e.g. "podcasts") A podcast show is promoted for queries with specific QUS signals A podcast show linked to results in the podcast episodes response is promoted to top result A podcast show related to a QUS KG mid is identified and selected using YTKS Response presented from LLM which was pre-computed for this query. For artist queries, top result will be selected from artists only using Top Result Model. When a podcast show playlist is the candidate for Top Result, and there is an episode selected for the user by GetSelectedEpisodeDocid(), then that selected episode video replaces the show and becomes the Top Result. Currently, the selected episode is the last unfinished episode of the show. type string youtubeMusicTopResultTriggerLogicBeforeMutators enum TOP_RESULT_TRIGGER_LOGIC_UNKNOWN ALLOWLIST MY_MIX PRESELECT_HIGH_DVQ ARTIST_MIX_INTENT GENRE_MIX_MATCH_GENRE_QUERY PLAYLIST_HIGH_DVQ QUERY_MIX_MATCH_GENRE_QUERY_OR_KEY_WORDS TWIDDLER_ANNOTATION QUERY_SIGNAL FALLBACK_DOC_TRUST PRESELECT_PMV_LOW_DVQ GENRE_MIX_NOT_MATCH_GENRE_QUERY QUERY_MIX_NOT_MATCH_CONDITIONS PLAYLIST_LOW_DVQ FALLBACK_DVQ FALLBACK_IR_SCORE ARTIST_SWAP_TO_STATION CURATED_PLAYLIST SWAP_VIDEO_WITH_ATV TOPICAL_MIX HIGH_QUALITY_NEW_ALBUM ASSISTANT_SIGNAL BROAD_VOICE_PLAYLIST MODEL_BASED_SCORE LISTENED_PLAYLIST LIKED_SONGS_PLAYLIST ATTRIBUTE_RADIO ASSISTANT_INTENT_TYPE_TOP_RESULT_MODEL FALLBACK_ALBUM RANKED_RADIO ATV_VERSION_SWAP ASSISTANT_EXPLICIT_INTENT_TYPE MODEL_BASED_SCORE_RANDOMIZATION HEURISTIC_PODCAST_SHOW_USING_SHOW_ENTITY ALBUM_QUERY_TOP_RESULT_MODEL RECAP_PLAYLIST TRIGGERING_WORDS_PODCAST_SHOW_HEURISTIC QUS_PODCAST_SHOW_HEURISTIC EPISODES_PODCAST_SHOW_HEURISTIC YTKS_PODCAST_SHOW_HEURISTIC OFFLINE_LLM_RESPONSE ARTIST_QUERY_TOP_RESULT_MODEL SELECTED_EPISODE_VIDEO_FROM_SHOW enumDeprecated False False False False False False False False False False False False False False False False False False False False False False False True False False False False False False False False False False False False False False False False False False False False enumDescriptions Top result isn't setted. Top result is selected from allowlist. Play some music use case. Top result is selected from a pre-check on PMV using a high_threshold dvq. Top result is selected based on artist mix intent. Top result is selected from genre mix matching genre query mid. Top result is selected from playlist with a high_threshold dvq. Top result is selected from query mix matching genre query mid or query contains mix triggering keywords. Top result is selected from a twiddler annotated result, e.g. latest twiddler. Top result is selected based on query signals. Top result is selected using trust based fallback. Top result is selected from a pre-check on PMV using a low_threshold dvq. Top result is selected from genre mix without match conditions. Top result is selected from query mix without match conditions. Top result is selected from a low-threshold dvq check on playlists. Top result is selected using highest dvq within response. Top result is selected based on highest IR score within response. Top result selected based on Curated station presence for genre/query intent. Prefer ATV matching the video if the video is the top result and there exist a linked atv. Top result selected from topical mix Top result is selected from predicted high quality new album. Top result selected based on Assistant signals. Top result is a randomized playlist chosen for broad voice queries. Top result selected based on ranking results from various shelf directly. Top result based on user listened playlist. Top result selected from Liked Songs Playlist. Top result selected from Attribute Radio. Top result selected with top result model from content types matching Assistant intent type. Top result album fallback if no other album is selected. To result selection from the ranked radios/mixes Swap ATV to a better version, e.g. non canonical version swapped to studio version. Top result selected based on explicit intent type in Assistant intent. E.g. the user explicitly said the word "album" in the query. Top Result selected randomly from top N results based on top result model. Top result is selected using kg mid corresponding to a KG podcast show For album queries, top result will be selected from albums only using Top Result Model. Top result selected from Recap Playlist. A podcast show is promoted for queries with specific triggering words (e.g. "podcasts") A podcast show is promoted for queries with specific QUS signals A podcast show linked to results in the podcast episodes response is promoted to top result A podcast show related to a QUS KG mid is identified and selected using YTKS Response presented from LLM which was pre-computed for this query. For artist queries, top result will be selected from artists only using Top Result Model. When a podcast show playlist is the candidate for Top Result, and there is an episode selected for the user by GetSelectedEpisodeDocid(), then that selected episode video replaces the show and becomes the Top Result. Currently, the selected episode is the last unfinished episode of the show. type string youtubeMusicUrlBeforeMutators description "Mutators" are the additional processing steps after the Top Result Model, e.g. it can switch an artist result to an artist radio, and switch between OMVs with ATVs. Info of result right after the Top Result Model, before the mutators. type string type object YoutubeImpression id YoutubeImpression properties intArg description Copied to YouTubeGWSLogEntryProto.Impression.IntArgs format int32 type integer tag description Human readable text, not a serialized proto. Copied to YouTubeGWSLogEntryProto.Impression.Tag type string textArg description Human readable text, not a serialized proto. Copied to YouTubeGWSLogEntryProto.Impression.TextArgs type string type object servicePath title Google Assistant API version v1beta1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/embeddedassistant-v1	values_changed root['revision'] new_value 20250206 old_value 20250203
prod/embeddedassistant-v1alpha2	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/embeddedassistant-v1beta1	values_changed root new_value basePath baseUrl https://embeddedassistant.googleapis.com/ batchPath batch canonicalName Embedded Assistant description Google Assistant API discoveryVersion v1 documentationLink https://developers.google.com/assistant/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id embeddedassistant:v1beta1 kind discovery#restDescription mtlsRootUrl https://embeddedassistant.mtls.googleapis.com/ name embeddedassistant ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources deviceModels methods create description Creates a device model. flatPath v1beta1/projects/{projectsId}/deviceModels httpMethod POST id embeddedassistant.projects.deviceModels.create parameterOrder parent parameters parent description Name of the project with the form: `projects/{project_id}`. location path pattern ^projects/[^/]+$ required True type string path v1beta1/{+parent}/deviceModels request $ref DeviceModel response $ref DeviceModel delete description Deletes a device model. flatPath v1beta1/projects/{projectsId}/deviceModels/{deviceModelsId} httpMethod DELETE id embeddedassistant.projects.deviceModels.delete parameterOrder name parameters name description Name of the device model with the form: `projects/{project_id}/deviceModels/{device_model_id}`. location path pattern ^projects/[^/]+/deviceModels/[^/]+$ required True type string path v1beta1/{+name} response $ref DeleteDeviceModelResponse get description Returns the device model with the given ID. flatPath v1beta1/projects/{projectsId}/deviceModels/{deviceModelsId} httpMethod GET id embeddedassistant.projects.deviceModels.get parameterOrder name parameters name description Name of the device model with the form: `projects/{project_id}/deviceModels/{device_model_id}`. location path pattern ^projects/[^/]+/deviceModels/[^/]+$ required True type string path v1beta1/{+name} response $ref DeviceModel list description Lists all of the device models for the given project ID. Limit: 1,000 results. flatPath v1beta1/projects/{projectsId}/deviceModels httpMethod GET id embeddedassistant.projects.deviceModels.list parameterOrder parent parameters parent description Name of the project with the form: `projects/{project_ID}`. location path pattern ^projects/[^/]+$ required True type string path v1beta1/{+parent}/deviceModels response $ref ListDeviceModelsResponse update description Updates a device model. `Note:` this overwrites the DeviceModel content, so the request should contain the entire DeviceModel. flatPath v1beta1/projects/{projectsId}/deviceModels/{deviceModelsId} httpMethod PUT id embeddedassistant.projects.deviceModels.update parameterOrder name parameters name description Name of the device model with the form: `projects/{project_id}/deviceModels/{device_model_id}`. location path pattern ^projects/[^/]+/deviceModels/[^/]+$ required True type string path v1beta1/{+name} request $ref DeviceModel response $ref DeviceModel revision 20250206 rootUrl https://embeddedassistant.googleapis.com/ schemas AlarmCapability description Capability with regard to support of alarms by the client. id AlarmCapability properties maxSupportedAlarms description Maximum number of alarms that can be created on the client. Zero or unset indicates no maximum limit. format int32 type integer restrictAlarmsToNextDay description Whether the client restricts alarms to ring within the next 24 hours. type boolean type object App description Configuration for an available app. Defines a unique key for the app along with multiple user-friendly names. id App properties key description A canonicalized identifier for the app. type string names description List of nicknames for a specific app, e.g., "Google" or "Google App". items type string type array type object AppSettingCapability description Configures the UI for SDK devices on the Assistant App. For example, you can change: language, notification, and input/output methods. id AppSettingCapability properties disableLanguageDisplay description If set, the device won't show its supported query language on the Assistant App. If not set, the language shown on the Assistant App will override the client's language when applicable. To enable this, devices must provide an interface for the user to set the language. type boolean type object ArgSpec description Argument associated with an Intent. id ArgSpec properties intValueSpec $ref IntValueSpec optionValueSpec $ref OptionValueSpec type enum TYPE_UNSPECIFIED BOOL INTEGER OPTION enumDescriptions A type must be specified. The arg value type is boolean. The arg value type is integer. The value can be any integer unless IntValueSpec is provided. The arg value is from list of options. The valid options are specified from OptionValueSpec. type string type object AvailableApps description A universal set of available apps provided for app understanding. id AvailableApps properties disableGoogleApps description To prevent Google's catalog of apps from being enabled by default, then set `disableGoogleApps` to `true` in the device model. type boolean localizedApps description List of apps which should be enabled. items $ref LocalizedApps type array type object AvailableChannels description A universal set of available channels provided for channel understanding. id AvailableChannels properties disableGoogleChannels description To prevent Google's catalog of channels from being enabled by default, then set `disableGoogleChannels` to `true` in the device model. type boolean localizedChannels items $ref LocalizedChannels type array type object Channel description Configuration for an available channel. Defines a unique key for the channel along with multiple user-friendly names. id Channel properties key type string names description List of nicknames for a specific channel, e.g., "NTGEO" or "National Geographic" or "Nat Geo". items type string type array number description The channel number as viewed by user. This field is not an exclusive field to key/names. type string type object CloudCapability description Lists which cloud endpoint(s) to use for cloud execution of actions or registration. id CloudCapability properties cloudEndpoints description The list of CloudEndpoints supported by this Device Model. Each endpoint should have a unique `name`. If any cloud endpoints are provided here, then the first one in the list will be used by default for all Cloud Execution. An Intent may override the default by providing an `execution_config`. items $ref CloudEndpoint type array type object CloudEndpoint description A cloud endpoint associated with this device, which may be invoked for query parsing or cloud execution. id CloudEndpoint properties name description The name for this cloud endpoint. It must be unique within a Device Model. Ex: "sample-nlu-endpoint" type string scopes description The list of scopes to be provided in the OAuth2 token. They must be a subset of the scopes registered in the Account Linking flow, or the request will fail. If the client itself provides the token, then this field is ignored. items type string type array url description The URL for this endpoint. It must start with "https". type string type object DeleteDeviceModelResponse description Response message for DevicesPlatformExternalService.DeleteDeviceModel. id DeleteDeviceModelResponse properties type object DeviceActionCapabilities description Represents device action capabilities. id DeviceActionCapabilities properties builtInIntentMode description Specifies behavior for built-in device actions for this device model. If not specified, defaults to ENABLE_CONFIGURED_INTENTS_ONLY. enum CUSTOM_INTENT_CAPABILITY_UNSPECIFIED ENABLE_ALL ENABLE_ALL_AUTO_ACTIONS ENABLE_CONFIGURED_INTENTS_ONLY PUNT_FOR_UNCONFIGURED_INTENTS enumDescriptions All intents are enabled, regardless of whether the intent is registered in the `intents` field. All Auto device actions are enabled, regardless of whether the intent is registered in the `intents` field. Only use it for Auto device type. Only the intents registered in the `intents` field will be enabled. Only the intents registered in the `intents` field will be enabled. Additionally, read an error message when the unconfigured intents are invoked. type string customIntentMode description Specifies which custom device actions should be enabled for this device model. This will only affect the behavior of intents corresponding to those from the Action Package of this project. If not specified, defaults to ENABLE_ALL. enum CUSTOM_INTENT_CAPABILITY_UNSPECIFIED ENABLE_ALL ENABLE_ALL_AUTO_ACTIONS ENABLE_CONFIGURED_INTENTS_ONLY PUNT_FOR_UNCONFIGURED_INTENTS enumDescriptions All intents are enabled, regardless of whether the intent is registered in the `intents` field. All Auto device actions are enabled, regardless of whether the intent is registered in the `intents` field. Only use it for Auto device type. Only the intents registered in the `intents` field will be enabled. Only the intents registered in the `intents` field will be enabled. Additionally, read an error message when the unconfigured intents are invoked. type string defaultExecutionConfig $ref ExecutionConfig description Default instructions for routing intents. If you want to override this setting for specific intents, provide the new data in the `intents` field. inlinedActionCapability $ref InlinedActionCapability description Specifies capabilities for device actions that are inlined in the DeviceAction message in the response. intents description Intent configurations: built-in and custom intents can be configured here. Built-in intents will always behave with IntentMode of `ENABLE_CONFIGURED_INTENTS_ONLY`. The IntentMode for custom intents can be changed using the `custom_intent_mode`. To configure an intent, list it here with its intent name. For example: "MY_CUSTOM_INTENT", "google.assistant.car.model.capabilities.AC_TEMPERATURE". items $ref Intent type array providedData description Provided data which augments the device action capabilities. Some built-in intents may require additional configuration to be provided. One example could be the list of channels available for the SelectChannel intent. For more details on what provided_data is available, see the individual intent documentations. # JSON The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: { "@type": "type.googleapis.com/google.assistant.devices.v1beta1.intent.AvailableChannels", "localizedChannels": [{ "locale": , "channels": [{ "key": , "names": [, ... ] }] }] } items $ref ProvidedData type array traits deprecated True description List of built-in traits the device can support. For example, "action.devices.traits.OnOff". Deprecated, traits should be registered as intents. items type string type array type object DeviceModel description Defines metadata and common capabilities for a family of devices. id DeviceModel properties capabilities $ref DeviceModelCapabilities description Optional. Describes the capabilities of the Device Model. clientId description Auth client ID that is created for this device model. type string deviceModelId description Required. Global unique ID specified by developer such as: “smart-robot-voice-assistant-2018-v1”. type string deviceType description Required. Some valid device types include: - `action.devices.types.LIGHT`. - `action.devices.types.OUTLET`. - `action.devices.types.SWITCH`. - `action.devices.types.TV`. type string lastUpdatedTime description Last updated timestamp. format google-datetime type string localeData description Required. Locale is in BCP 47 format: en-US, en-CA. items $ref LocaleData type array name description Name of the device model with the form: `projects/{project_id}/deviceModels/{device_model_id}`. type string projectId description Required. Cloud project ID associated with the device model. Projects are allowed to create multiple device models. type string type object DeviceModelCapabilities description Lists capabilities of a Device Model. id DeviceModelCapabilities properties appSetting $ref AppSettingCapability cloud $ref CloudCapability deviceAction $ref DeviceActionCapabilities routine $ref RoutineCapability signInMethod $ref SignInMethod visualOutput $ref VisualOutputCapability wifiCalling $ref WifiCallingCapability type object Dimensions description This contains physical and logical characteristics about the device (e.g. screen size and DPI, etc). id Dimensions properties screenDpi description Dots (pixels) per inch of the screen. format float type number screenHeightPx description Height of the device's screen in pixels. format int32 type integer screenShape description The shape of the device's screen enum SCREEN_SHAPE_UNSPECIFIED SCREEN_SHAPE_OVAL SCREEN_SHAPE_RECT enumDescriptions Screen shape is undefined. A round screen (typically found on most Wear devices). Rectangular screens. type string screenWidthPx description Width of the device's screen in pixels. format int32 type integer type object DisambiguationAnnotation description Annotations from disambiguation dialog. next id: 9 id DisambiguationAnnotation properties conversationId description Assistant conversation id. This is the id to join with user disambigution event, and other dialog annotations. type string disambiguationCandidates description The disambiguate candidates. This is an ordered list in the same order as the ambiguation list displayed for users. items $ref ResultInfo type array disambiguationReason description The reasons why Sophia dialog decides to initiate a disambiguation. This is a repeated field that can contain multiple reasons. items enum DISAMBIGUATION_REASON_UNKNOWN SONG_SONG_DISAMBIGUATION SONG_ALBUM_DISAMBIGUATION enumDescriptions type string type array noDisambiguationReason description The reasons why Sophia dialog decides no disambiguation is needed. items enum NO_DISAMBIGUATION_REASON_UNKNOWN NOT_AMBIGUOUS PREVIOUSLY_DISAMBIGUATED enumDescriptions The results are not ambiguous. This is a general code. If there is more detailed reason from disambigous model, please use the deatailed reason. User has made a successful disambiguation for the same intent before. Thus no need for disambiguation again. type string type array status description The status of the diambiguation dialog. enum DISAMBIGUATION_UNKNOWN DISAMBIGUATION_NOT_NEEDED DISAMBIGUATION_INITIATED DISAMBIGUATION_CONFIRMED DISAMBIGUATION_SUCCEEDED DISAMBIGUATION_CANCELLED enumDescriptions The disambiguation model decides there is no need to trigger disambiguation. A disambiguate flow is initiated, e.g. "Do you mean the album?." The user confirms the disambiguate query. For a confirm query, both "yes" and "no" are confirmations. For list selection disambiguate, any selection or "no thank you" is a confirmation. The disambiguation succeeds. For a confirmed query, "yes" counts as a success. For list selection disambiguate, any selection is a success. User cancels the disambiguation flow. type string topResultCandidate $ref ResultInfo description Top result candidate. The go to play result before disambiguation. type object ExecutionConfig description Specifies the intent's routing capabilities. id ExecutionConfig properties cloudEndpointName description Instructions for performing a cloud execution request for the Intent when the `execution_type` is set to `CLOUD`. If non-empty, then the device execution is routed to the CloudEndpoint specified by this name. The Account Linking exchange may be performed to fetch the OAuth access token, and the access token will be included in the HTTP header. type string intentCommandFormat description Specifies the intent command format for this Action. For example, in order to launch an Android intent instead of receiving the device action payload on the client, then this field can be set with "intent:/#Intent;...;my_extra={$.params.channels[0].channelCode};end" The parameter "{$.params.channels[0].channelCode}" is in JSON path format, and will be replaced with the content from the original device action payload. Thus, with # JSON "execution": [ { "command": "action.devices.commands.SelectChannel", "params": { "channels": [{ "channelName": "exampleChannel", "channelCode": "1-1" }] } } ] as the original action result, then the final result would look like "intent:/#Intent;...;my_extra=\"1-1\";end" type string localDisabled description If this field is set, then local execution capability is disabled for all matching intents. type boolean localExecutionType description Specifies how to execute this Action when it is invoked locally (from the same device). enum DEFAULT CLOUD enumDescriptions Route requests directly to the device via the regular channel. Route all execution requests to cloud. type string remoteDisabled description If this field is set, then remote execution capability is disabled for all matching intents. type boolean remoteExecutionType description Specifies how to execute this Action when it is invoked remotely (from a different device). enum DEFAULT CLOUD enumDescriptions Route requests directly to the device via the regular channel. Route all execution requests to cloud. type string type object InlinedActionCapability description Specifies capabilities for device actions that are inlined in the DeviceAction message. id InlinedActionCapability properties alarm $ref AlarmCapability description Specifies capabilities for handling on-device alarms. The presence of this field, even if empty, implies that the device supports alarms. responseLimits $ref ResponseLimits description Specifies the size limits on responses. If this message is not defined then no limits exist. timer $ref TimerCapability description Specifies capabilities for handling on-device timers. The presence of this field, even if empty, implies that the device supports timers. type object IntValueSpec id IntValueSpec properties maxValue format int64 type string minValue format int64 type string type object Intent description An intent configures the behavior of a device action for this device. id Intent properties argSpecs additionalProperties $ref ArgSpec description List of arguments associated this intent. Each argument must be defined with a template describing the valid arguments. type object executionConfig $ref ExecutionConfig description Instructions for the routing of this Intent. name description The name of the intent. type string providedDataNames description List of provided data names used by this intent. Note that some built-in intents will not function properly without provided data, such as `action.intent.SwitchChannel` or `action.intent.AppSelector`. items type string type array securityConfig $ref SecurityConfig description Security configuration for this Intent. type object ListDeviceModelsResponse description Response message for DevicesPlatformExternalService.ListDeviceModels. id ListDeviceModelsResponse properties deviceModels items $ref DeviceModel type array type object LocaleData description Localized Device Model metadata. id LocaleData properties locale description Required. Locale is in BCP 47 format: en-US, en-CA. type string manifest $ref Manifest description Required. Metadata that describes the device model and manufacturer. This will be shown in the SDK console, metrics dashboards, and other related visual interfaces. type object LocalizedApps description Apps are available in various locales. For each locale, a set of global apps can be defined. id LocalizedApps properties apps description List of supported apps for this locale. items $ref App type array locale description Locale is in BCP 47 format. eg. en-US, en-CA. type string type object LocalizedChannels description Channels are available in various locales. For each locale, a set of global channels can be defined. id LocalizedChannels properties channels items $ref Channel type array locale description Locale is in BCP 47 format. eg. en-US, en-CA. type string type object Manifest description Metadata that describes the device model and manufacturer. This will be shown in the SDK console, metrics dashboards, and other related visual interfaces. id Manifest properties defaultNames description Optional. Set of nicknames provided to target the device correctly during assistant interactions. items type string type array deviceDescription description Description of this device model, such as "Sample robot with the Google Assistant Built-in". type string logoUrl description The URL to the LOGO image of the manufacturer. The manufacturer's LOGO is used on the disclosure page in adjunction to Google Assistant's own LOGO. The LOGO image should be a .svg file and have a transparent background. type string manufacturer description Required. Manufacturer of this device model, such as "Robot corp.". This may be used to name the device for remote execution. type string productName description Required. Consumer facing product name for this device model, such as "Sample Robot 2018". This may be used to name the device for remote execution. type string type object MusicQueryInfo description Message used for intent logging of broad queries. go/ytm-broad-query-experiments Next ID: 7. id MusicQueryInfo properties genre description Genre intent if it's a broad music query. enum GENRE_TYPE_UNSPECIFIED AFROBEATS ALTERNATIVE_INDIE AXE BENGALI_FILM_POP BHOJPURI_FILM_POP BLUES CANTOPOP_HK_POP CHILDRENS_MUSIC CHRISTIAN CLASSICAL COMEDY_SPOKEN_WORD_OTHER COUNTRY DANCE_ELECTRONIC FOLK FORRO FRENCH_VARIETIES FUNK_BRASILEIRO GHAZAL GOSPEL GUJARATI_FILM_POP HINDI_FILM_POP HIP_HOP_RAP HOLIDAY INDIAN_CLASSICAL INDIAN_DEVOTIONAL INDIAN_FILM_POP_OTHER_LANGUAGES INDIAN_FOLK INDIAN_POP INDIAN_FILM_POP INDIAN_HIP_HOP JAZZ J_POP KANNADA_FILM_POP KOREA_BALLADS KOREA_DANCE KOREA_TROT K_POP LATIN_POP LATIN_URBANO MALAYALAM_FILM_POP MANDOPOP MARATHI_FILM_POP METAL MPB MUSIQUE_FRANCOPHONE MUSICA_TROPICALE NATURAL_SOUNDS NEW_AGE POP PUNJABI_FILM_POP RAP_QUEB REGGAE REGIONAL_BRAZILIAN REGIONAL_MEXICAN ROCK RUMBA_FLAMENCA R_B_SOUL SAMBA_E_PAGODE SCHLAGER_VOLKSMUSIK SERTANEJO SOUNDTRACKS TAMIL_FILM_POP TELUGU_FILM_POP UK_RAP ADULT_CONTEMPORARY AFROPOP ANIME AUSTRALIAN_HIP_HOP_RAP BHANGRA BRASIL_EDM CANTAUTORES CANTAUTORI_ITALIANI DANISH_HIP_HOP DANISH_POP DISCO_POLO DUTCH_POP DUTCH_RAP FADO FINNISH_HIP_HOP FINNISH_POP FINNISH_ROCK FRENCH_HIP_HOP FRENCH_POP GERMAN_HIP_HOP GERMAN_POP GERMAN_ROCK GRIME HIP_HOP_BRASILERO HIP_HOP_EN_ESPANOL HORBUCHER HORSPIELE ITALIAN_HIP_HOP ITALIAN_POP JAPAN_ALT_INDIE JAPAN_CHILDRENS_MUSIC JAPAN_COMEDY_SPOKEN_WORD JAPAN_DANCE_ELECTRONIC JAPAN_EDM JAPAN_HIP_HOP JAPAN_REGGAE JAPAN_ROCK KARAOKE KAYOKYOKU KOREA_ALTERNATIVE_ROCK KOREA_ALT_INDIE KOREA_CCM KOREA_CHILDRENS_MUSIC KOREA_EDM KOREA_HIP_HOP_RAP KOREA_INDIE_FOLK KOREA_OST KOREA_REGGAE KOREA_ROCK KOREA_R_B_SOUL KOREA_TRADITIONAL_MUSIC LATIN_TRAP MUSICA_RELIGIOSA POLISH_POP POP_NACIONAL PORTUGUESE_HIP_HOP PORTUGUESE_POP_ROCK ROCK_EN_ESPANOL ROCK_NACIONAL ROCK_Y_ALTERNATIVO RUSSIAN_HIP_HOP_RAP RUSSIAN_POP RUSSIAN_ROCK RUSSIAN_SHANSON SINGER_SONGWRITER SPANISH_HIP_HOP TURKISH_HIP_HOP URDU_FILM_POP VOCAL_EASY_LISTENING WORLD enumDeprecated False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False False True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True True enumDescriptions Música popular brasileira Deprecated TLGs. type string genreMid description KG mids associated with a genre music query. For a query like "classic rock", there will be 2 KG mids: 1. One for "rock" - Top Level Genre 2. One for "classic rock" - sub-genre of "rock" KG mids are ordered by confidence_score from Query Understanding in case of multiple genres. For "classic rock" query, "classic rock" KG mid is likely to precede "rock" KG mid. items type string type array moodActivity description MoodActivity intent if it's a broad music query. enum INTENT_UNKNOWN INTENT_HOME INTENT_WORK INTENT_COMMUTE INTENT_WORKOUT INTENT_SLEEP INTENT_FOCUS INTENT_RELAX INTENT_FEEL_GOOD INTENT_ENERGIZE INTENT_SAD INTENT_FAMILY INTENT_PODCAST INTENT_ROMANCE INTENT_PARTY enumDeprecated False True True False False False False False False False False False False False False enumDescriptions type string queryIntent enum QUERY_INTENT_UNKNOWN SONG ARTIST ALBUM PLAYLIST_PERSONAL PLAYLIST_PUBLIC PLAY_MUSIC_GENERAL RECOMMEND_MUSIC GENRE MOOD ACTIVITY LIKED_SONGS enumDescriptions Personal playlists including auto-generated playlists such as ‘Liked songs.’ Set when user is requesting a specific public playlist (includes programmed playlists, topical mixes, etc.) Unconstrained 'Play Music' query, in which the user provides no additional arguments. 'Recommend Music' query. On Assistant this results in a set of playlists which the user can traverse by saying 'play something else.' Genre queries, e.g. jazz music. Mood query, e.g. happy music. Activity query, e.g. workout music. Liked songs intent, e.g. 'play my liked songs'. type string queryType enum QUERY_TYPE_UNKNOWN NAVIGATIONAL BROAD enumDescriptions Queries for a specific album, artist, song, or playlist (including personal playlists.) Queries that do not correspond to a specific entity. Includes moods, genres, decades, activities, etc. type string seekingLockerContent description Denotes if the intent was to play locker track/album/artist. type boolean type object MusicTrackData description Music Track data. Next ID: 3 id MusicTrackData properties videoId description Encrypted youtube external video id. type string videoSid description Surrogate field for video_id. format int64 type string type object OptionValueSpec id OptionValueSpec properties values items type string type array type object PRequestContext description Represents the public API for storing pToken/privacy attributes in PrivacyContext, to be automatically propagated across RPC chains. Public and testing APIs exist in C++ and Java: - google3/privacy/ptoken/public/propagation/ - google3/privacy/ptoken/public/request_context.h - google3/privacy/ptoken/public/testing/request_context.h - google3/privacy/ptoken/public/logging/request_context_logging.h - google3/java/com/google/privacy/ptoken/propagation/RequestContextApi.java - google3/java/com/google/privacy/ptoken/propagation/RequestContextTestingApi.java - google3/java/com/google/privacy/ptoken/propagation/RequestContextLoggingApi.java NOTES: - Be careful when modifying this proto because it's potentially included in every RPC request in the fleet. Be careful with its size, and with backward compatibility of changes. - PRequestContext must include ONLY basic types and Enums. This is required in order to avoid external dependencies in the logged container (per go/proto-guidelines). - Some fields are mirrored in LoggedPRequestContext at //logs/proto/privacy/ptoken/logged_request_context.proto, which must remain wire-compatible with this proto. Any fields that appear in both must use the same type and tag number. When deleting a field from PRequestContext, the LoggedPRequestContext version must remain for backwards compatibility of stored data, so please migrate its documentation to the LoggedPRequestContext message. For more details on LoggedPRequestContext see go/ptoken-prc-logs. - Each field should have a comment specifying the needed merge logic. Per-field merging and modification must be implemented in C++ and Java. See go/prequestcontext#new-field. See go/ptoken-rfc-prequestcontext for more details. Next ID: 37 id PRequestContext properties adsProcessingPurpose description The ads processing purpose for which processing is happening. Value & enum copied from ProcessingPurpose proto. This will be used in combination with processing purpose to provide DMA 5(2) exemptions. Merge logic is take the entire new processing_purpose if present. items enum DATA_USAGE_NONE DATA_USAGE_TARGETING DATA_USAGE_NEGATIVE_AD_SELECTION_NEEDS_PRIVACY_APPROVAL DATA_USAGE_LOGGING DATA_USAGE_GENERATE_PREDICTION_QEM DATA_USAGE_GENERATE_PREDICTION_QEM_WITH_CARVEOUT_NEEDS_PRIVACY_APPROVAL DATA_USAGE_LOGGING_FOR_TARGETING DATA_USAGE_PRIVACY_CONTROL_NEEDS_PRIVACY_APPROVAL DATA_USAGE_AD_EXCHANGE DATA_USAGE_ADSPAM DATA_USAGE_READ_FOR_KANSAS_WRITE DATA_USAGE_MEASUREMENT_EXTERNAL DATA_USAGE_MEASUREMENT DATA_USAGE_EXPERIMENTS DATA_USAGE_AGGREGATE_SERVER_METRICS DATA_USAGE_CHECK_COOKIE_LINKAGE_NEEDS_PRIVACY_APPROVAL DATA_USAGE_COOKIE_MATCHING DATA_USAGE_CLICK_URL_CUSTOMIZATION DATA_USAGE_ADX_TARGETING_IN_SUPERMIXER DATA_USAGE_TRIGGER_ELIGIBLE_COOKIE_LINK_NEEDS_PRIVACY_APPROVAL DATA_USAGE_SHARE_EXTERNALLY DATA_USAGE_CROSS_DOMAIN_SEQUENCING_NEEDS_PRIVACY_APPROVAL DATA_USAGE_PUBLISHER_DATA_PREDICTION_PROCESSING_AND_SHARING DATA_USAGE_UI_CUSTOMIZATION DATA_USAGE_POLICY_CONTROL_NEEDS_PRIVACY_APPROVAL DATA_USAGE_COUNTERFACTUAL_EXPERIMENT DATA_USAGE_FILL_CLICK_URL_DATA_NEEDS_PRIVACY_APPROVAL_DEPRECATED DATA_USAGE_MUTES DATA_USAGE_READ_LOC_CONTEXT_FOR_GEO_LOC_DATA_PROTO_NEEDS_PRIVACY_APPROVAL DATA_USAGE_READ_FROM_CACHE_NEEDS_PRIVACY_APPROVAL DATA_USAGE_VIDEO_ADS_SEQUENCING DATA_USAGE_A1_INFRA_DMA52_POLICY_CONTROL_CARVE_OUT_NEEDS_PRIVACY_APPROVAL DATA_USAGE_STORE_VISIT_LIFT_MEASUREMENT DATA_USAGE_SURVEY_LIFT DATA_USAGE_SHARE_EXTERNALLY_IN_BID_REQUESTS DATA_USAGE_INFRASTRUCTURE_METRICS_NEEDS_PRIVACY_APPROVAL DATA_USAGE_PROVISION_OF_SERVICE_INFRASTRUCTURE_NEEDS_PRIVACY_APPROVAL DATA_USAGE_VERIFICATION_TESTING_VALIDATION_NEEDS_PRIVACY_APPROVAL DATA_USAGE_MEDIATION_GROUP_SELECTION DATA_USAGE_CONVERSION_ATTRIBUTION DATA_USAGE_A1_INFRA_AADC_INFERENCE_PRIVACY_CONTROL_CARVEOUT enumDeprecated False False False False False False False False False False False False False False False False False False False False False False False False False False True False False False False False False False False False False False False False False enumDescriptions Selecting/filtering ads. All typical usages of data within a targeting server (positive/negative targeting, filtering, etc) can be represented using this value. There are only a few exceptions in targeting servers that should use DATA_USAGE_NEGATIVE_AD_SELECTION_NEEDS_PRIVACY_APPROVAL instead. See DATA_USAGE_GENERATE_PREDICTION_QEM for a special case of targeting. This is a subclass of targeting that refers to usages of user data that limit the number of times a certain ad is shown. The primary example for this is frequency capping, but other features (for example, app-install based filtering) may also qualify. For some profiles (impression history in particular), this usage has privacy carveouts to be allowed for targeting-restricted requests. For mute ads and advertisers mutes, please use DATA_USAGE_MUTES instead. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/SAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR THIS USAGE! Logging to sawmill logs (not task logs). Note that the policy for DATA_USAGE_LOGGING is implemented as a subset of privacy-allowable policy to support quality considerations, as models train off of logs and want to avoid logging data that can't be used for targeting (which causes training/prediction skew). Usage of user data for creation of prediction QEMs. Do not use this for general targeting. This usage is only for creating prediction (mini-)QEMs. A special version of the GENERATE_PREDICTION_QEM that is eligible to include user data with privacy carveouts under the condition that the prediction models do not cross any such carveout data with interest categories. This allows, e.g., frequency capping profiles to be used as per-ad-candidate prediction signals on privacy sensitive requests. NOTE: As of 2021`Q2 this usage is confined only to Gmob mixer and only supports legacy cases. PLEASE DO NOT ADD NEW USE CASES; if there are really new use cases that fit this carveout, they should be incorporated into enforcement detailed in go/daml-privacy-enforcement-design, not blithely promised by the accessing client via this usage. Refers to usages of user data where logging happens specifically for targeting. For example, impression history is generally allowed to be logged (for fcap), but there are products such as ads reach which log impression history only to build targeting models, which should not receive carveouts for privacy sensitive requests. Accordingly, we map this use case to a more strict subset of generic logging. Usage of user data for enforcement of privacy logic or privacy risk mitigations, e.g., fetching of privacy risk metrics by AdX for reidentification mitigation. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. For pToken policy engine (aka Tokotoko), this usage is equivalent to ProcessingPurpose::COMPLIANCE_LEGAL_SUPPORT. Sending the user profiles to AdX RTBs. DATA_USAGE_SHARE_EXTERNALLY_IN_BID_REQUESTS will eventually replace DATA_USAGE_AD_EXCHANGE. A new data usage is required to conduct serving experiments with privacy policy changes applicable to DATA_USAGE_AD_EXCHANGE, such as access to the hosted match data for RTB partners. Used for serving or offline jobs for detecting spam. For pToken policy engine (aka Tokotoko), this usage is equivalent to ProcessingPurpose::TRUST_SAFETY_ANTI_FRAUD. Refers to using user data in order to create data that will be written to Kansas. Refers to usages of user data that enable measurent for publisher, advertisers, or any other external entities. For example, if the data is used to create pixels meant to be used by external companies, you should use DATA_USAGE_MEASUREMENT_EXTERNAL. Refers to using user data for measurement, e.g., conversion tracking, internal/external aggregate ads reporting, internal analysis etc. This is meant for measurement done by Google (i.e. internal). For measurement that involves individual user data (not aggregate metrics) sharing with external entities, please use DATA_USAGE_MEASUREMENT_EXTERNAL. Refers to using user data for experiment conditions. In particular, setting request properties. This is a special usage that refers to accessing user profiles in order to update varzs and streamzs that store aggregate information about the user profiles loaded (e.g., number of user profiles for the request). Do not use this for storing aggregate data in Kansas or logs. Refers to the usage of user data to determine whether or not a user has links on Mobius/Constellation/AdX Hosted Match, etc, for ephemeral, not-privacy related purposes. DO NOT USE THIS VALUE IF YOU USE THE COOKIE LINK STATUS TO MAKE PRIVACY RELATED DECISIONS! USE THIS VALUE ONLY TO CHECK FOR THE PRESENCE OF LINKS, NOT TO ACCESS ANY TARGET COOKIE. FOR ACCESS TO THE LINK TARGET, USE THE ACTUAL INTENDED USAGE INSTEAD, e.g. DATA_USAGE_TARGETING. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to usages of user data for initiating cookie matching. For example, using hosted match data to initiate push cookie matching. Refers to usages of user data for customizing the click URL. For example, using app install data to change the click URL depending on whether the promoted app is installed. AdX must not use user profiles in GAIA profile space which will generally be enforced by UDA execution context. We have some AdX specific UDA usages in supermixer that would get access to GAIA profiles because they are executed within Supermixer's ExecutionContext. To prevent access to GAIA profiles in these cases, we added DATA_USAGE_ADX_TARGETING_IN_SUPERMIXER with accordingly defined privacy policy rules. THIS IS SOMEWHAT HACKY so please don't copy this pattern elsewhere. DO NOT INTRODUCE ANY NEW USAGES OF THIS VALUE. Instead, all AdX specific code should be moved to AdX servers. Refers to the usage of user data to determine whether or not app cookie ( Device ID) can link to mobile web cookie(mobile browser DBL cookie), and trigger the actual linking if eligible. See go/mobius-impression-time-linking for more details. DISTIGUISH THIS WITH DATA_USAGE_CHECK_COOKIE_LINKAGE_NEEDS_PRIVACY_APPROVAL WHICH IS FOR CHECKING THE PRESENCE OF LINKS. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to usages of user data that are getting sent to external companies. Note that this usage does not allow data to be shared with bidders. This refers to usages of user data for ad sequencing, on the same site or across domains. Examples include ad rule and sequential rotation. Viral uses it for Video ad sequencing (go/videoads-sequence). Ad sequencing is similar to frequency capping/negative ad selection, except that there is a larger targeting/business motivation. Accordingly, some (but not all) carvouts for frequency capping apply also to ad sequencing. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to the processing of publisher-related user data by ML prediction and sharing the results with publishers for their benefit (not necessarily ads personalization). This is used for Subscription Optimization. For example, reading the propensity score of a user to subscribe to a publication, and sending it to the external publisher. For more information, please see go/sos-ml2 and go/subopt-ga-dd. Refers to usages of user data as an information provider. Data with this usage will not be used for ads personalization. For example, using cart data to calculate the quantity of cart items and display it in frontend. Refers to usages of user data for enforcement of policy control logic. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/SAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. DATA_USAGE_POLICY_CONTROL_NEEDS_PRIVACY_APPROVAL is a DMA5(2) exempted data usage approved in b/285159517 Refers to pass-through of user data for counterfactual experiment requests, in particular raw kansas lookup data. See go/experiment-counterfactuals#about-counterfactuals for background on counterfactuals. Notice: this should only be used in combination with proper fine-grained DATA_USAGE enforcement when the pass-through data is subsequently consumed in the mixer. See http://shortn/_2sEjLivCfa for more background. Refers to usage of data to populate a clickstring sent to event servers. Privacy checks at event time must ensure this data is safely used. PLEASE NOTE THAT POLICY IS ONLY IMPLEMENTED FOR PSEUDONYMOUS IDENTIFIERS. DO NOT USE THIS USAGE UNLESS YOU HAVE EXPLICITLY CONFIRMED THAT THE POLICY EXISTS FOR YOUR PROFILE (PROBABALY BY TALKING TO SAPT). THIS USAGE IS DEPRECATED; PLEASE DO NOT ADD NEW USE CASES WITHOUT CONSULTING SAPT. Refers to usage of user data to block/mute ads and advertisers as a result of user action (e.g., through "Block this ad" in My Ad Center). Refers to usage of data to populate GeoLocationData, which will be consumed to construct GeoDataAccessor inside Supermixer. The data comes from LES response. Please check go/les-response-paperplane for more details. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/SAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to reading user data from a cache, where the cache was populated with either the original or derived user data that had already passed the privacy checks for the original intended data usage. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/SAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to usage of user data for video ads sequencing. Refer to go/videoads-sequence for details. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to usage of user data for A1 infrastructure carve outs for DMA5(2). This usage will be used for carve outs with a non targeting purpose. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/SAPT/A1 HAS EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to usage of user data to determine whether we should do diversion for store visit lift experiments based on whether the user's location history is active. Created for FEATURE_STORE_VISIT_LIFT_MEASUREMENT for finer-grained usages. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Refers to usage of user data to determine whether we should use user data for survey lift. Created for FEATURE_SURVEY_LIFT for finer-grained usages. DO NOT USE THIS VALUE UNLESS YOU HAVE GONE THROUGH A PRIVACY REVIEW AND PRIVACY/DAPT HAVE EXPLICITLY CONFIRMED THAT YOUR USAGE MEETS THE CRITERIA FOR PRIVACY CARVE OUT. Share data externally in bid requests with RTB partners (products such as Authorized Buyers, Open Bidding, SDK bidding). This will serve as an eventual replacement for DATA_USAGE_AD_EXCHANGE. A new data usage is required to conduct serving experiments with privacy policy changes applicable to DATA_USAGE_AD_EXCHANGE, such as access to the hosted match data for RTB partners. We will be gradually migrating usages of DATA_USAGE_AD_EXCHANGE to DATA_USAGE_SHARE_EXTERNALLY_IN_BID_REQUESTS through serving experiments. DO NOT USE (YET). For now, new accesses of data for the purposes of populating in RTB bid requests should continue to use DATA_USAGE_AD_EXCHANGE, since privacy policies have not yet been fully updated to reference DATA_USAGE_SHARE_EXTERNALLY_IN_BID_REQUESTS. Once privacy policies are updated, new uses DATA_USAGE_SHARE_EXTERNALLY_IN_BID_REQUESTS will be allowed. For pToken policy engine (aka Tokotoko) compatibility ONLY. This usage is equivalent to ProcessingPurpose::INFRASTRUCTURE_METRICS. Any processing for the purpose of understanding how services and products are used by users and to gain insights into how the underlying infrastructure performs during their operation: e.g. any processing necessary to monitor a service and its performance to maintain product excellence, reliability, service quality, or other technical measures as perceived by a user - [description based on the corresponding ProcessingPurpose enum but excludes "traffic shaping" - see note below]. NOTE: The original ProcessingPurpose description includes "traffic shaping"; however, as discussed in screen/ZLddAkXK5ozwEbD, "metrics" usage should be limited to passive operations and traffic shaping is not passive. Therefore, for DATA_USAGE we have removed "traffic shaping" as a possible reason to use this value. USE of this VALUE is LIMITED to Stargate clients that need mapping from ProcessingPurpose to DataUsage for DMA 5(2) processing purpose exemptions (Goldfish and KeyVal only at this point). For pToken policy engine (aka Tokotoko) compatibility ONLY. This usage is equivalent to ProcessingPurpose::PROVISION_OF_SERVICE_INFRASTRUCTURE. This processing purpose may be used by jobs implementing low level multi-tenant infrastructure (e.g., Spanner, Sawmill, PS1). This purpose will grant an exemption to the DMA 5(2) policy, and, thus, its use is regulated (go/dma52-exemptions) - [description copied verbatim from the corresponding ProcessingPurpose enum]. USE of this VALUE is LIMITED to Stargate clients that need mapping from ProcessingPurpose to DataUsage for DMA 5(2) processing purpose exemptions (Goldfish and KeyVal only at this point). For pToken policy engine (aka Tokotoko) compatibility ONLY. This usage is equivalent to ProcessingPurpose::VERIFICATION_TESTING_VALIDATION. Processing for debugging or monitoring or somehow related to pure software functionality. Access in order to perform testing, verification, certification, or other routine or pre-launch analysis by using stored user data. This can include regression testing, load testing, unit/integration testing, or other analysis of machine-generated or replayed activity. This is done primarily for routinized, transient evaluation like testing new builds/deployments - [description copied verbatim from the corresponding ProcessingPurpose enum]. USE of this VALUE is LIMITED to Stargate clients that need mapping from ProcessingPurpose to DataUsage for DMA 5(2) processing purpose exemptions (Goldfish and KeyVal only at this point). For AdMob Mediation Group Selection usage ONLY. AdMob mediation group allows publisher to select a group of ad networks to compete for a specific ad request. This data usage is used to read the publisher provided data for mediation group selection purposes. The publisher provided data would not be sent to ad networks (including google demand) and would not be used for any other purposes. For more details, please refer to go/admob-mg-kv-dd. For conversion attribution/tracking usage ONLY. In particular, this data usage should be used for any APPROVED conversion attribution clients that rely on Ads Dual Observation (go/stargate-enforcement-for-ads-do). This is a subset of DATA_USAGE_MEASUREMENT. For non-conversion attribution clients, please use DATA_USAGE_MEASUREMENT instead. WARNING: This data usage is UNDER CONSTRUCTION. DO NOT USE IT without consulting with SAPT (PoC: sadiam@) For A1 infrastructure AADC inference profile building usage ONLY. The restrictions for this use-case are not able to be fully enforced using UDA PMv2 policy as of now and will have similar restrictions as DATA_USAGE_PRIVACY_CONTROL_NEEDS_PRIVACY_APPROVAL in the PMv2 policy. Additional restrictions will be applied using custom UDA enforcement utils outside of the PMv2 policy. See go/yt-organic-privacy-signal-propgation-and-enforcement-in-stargate for more details. WARNING: This data usage is only intended for A1 infrastructure. DO NOT USE IT without consulting with SAPT (PoC: saddo@) type string type array assistantGuestModeEnabled description Whether or not Assistant Guest Mode is in effect for this request. Should be explicitly set to false when AGM is known to be disabled to allow differentiation between known and unknown states (e.g. to catch potential propagation failures). Merge logic is logical OR. type boolean assistantIsSubjectToMinorModeRestrictionsForGuests description See go/ptoken-policy-assistant-aadc and go/assistant-aadc-logging-design for more on these two bits. Whether the account associated with the Assistant request is in a region in which Minor Mode (AADC) restrictions apply to ambiguous requests ("guests" in AADC terminology, but may be expanded later). Derived from IsSubjectToMinorModeRestrictionsForGuests account capability, where the AADC (and potential future geo->regulatory) decisions live. Merge logic is logical OR. type boolean assistantPocketIsEnabled description Whether this request has Pocket enabled. This is currently decided by device type and user opt-in status. We didn''t create separate bool fields for opt-in status and device type because the opt-in machanism is designed to let server treat request as if user was using Pocket-eligible devices. So the difference between eligibility from device type and eligibility from opt-in is delibrately abstracted away from the policy layer. See go/pocket-21 Merge logic is logical or. type boolean assistantPocketTriggeredFeatures description The triggered features in the Assistant response that are in the scope of Pocket. See go/pocket-21 Merge by set union. items enum UNKNOWN_POCKET_FEATURE POCKET_FEATURE_ACTION_TELEPORT_OPEN_APP POCKET_FEATURE_APP_CONTROL POCKET_FEATURE_DIGITAL_WELLBEING POCKET_FEATURE_INTENT_ACTION_PHOTO_FEATURE POCKET_FEATURE_LANGUAGE_PICKER_FEATURE POCKET_FEATURE_POWER POCKET_FEATURE_SLEEP_TIMER_SET_FEATURE POCKET_FEATURE_SLIDER_SETTING_FEATURE POCKET_FEATURE_TAKE_SCREENSHOT_FEATURE POCKET_FEATURE_TOGGLE_SETTING_FEATURE enumDescriptions go/keep-sorted start go/keep-sorted end type string type array assistantRequestAcceptanceStatus description The status of assistant request being accepted. By default the status is UNKNOWN, and it changes to AWAITING when the assistant server receives the request, and ACCEPTED when the assistant server determines that the request is intended, or REJECTED when the request is unintended. The request can also be CANCELLED by the Assistant (go/armaa-cancellations) or explicitly set to EXPLICIT_UNDEFINED (introduced for go/robin-hotword-sanitization). See go/ptoken-rfc-assistant-activation Contact: go/peals for inquiries and consultations on the policy compliance. Merge on the pRC is OVERWRITE by the priority value. Note that there is a different behavior for merging on pTokens. See the proto definition for more details. enum REQUEST_ACCEPTANCE_UNSPECIFIED REQUEST_ACCEPTANCE_AWAITING REQUEST_ACCEPTANCE_ACCEPTED REQUEST_ACCEPTANCE_REJECTED REQUEST_ACCEPTANCE_CANCELLED REQUEST_ACCEPTANCE_EXPLICIT_UNDEFINED REQUEST_ACCEPTANCE_AWAITING_WEAK REQUEST_ACCEPTANCE_ACCEPTED_WEAK REQUEST_ACCEPTANCE_REJECTED_WEAK enumDescriptions Unknown whether acceptance policy is applicable Applicable but waiting for the decision The request is accepted The request is rejected The request is cancelled. Note a REQUEST_ACCEPTANCE_CANCELLED_WEAK state is not needed because cancellation is an unambiguous signal that will not differ between different versions of Assistant Server code. See go/armaa-cancellations for more details. This request is explicitly set as undefined, in other words the request won't have a conclusive status for this request, and no one should override this value. Similar to the CANCELLED state, this is an unambiguous signal that won't be contested, and therefore does not need WEAK version. This status was introduced for go/robin-hotword-sanitization. Similar as above states, except that weak states cannot override the above states. type string assistantSurfaceRestriction description Assistant Surface restriction - describes Assistant Device's state relevant for policies. See go/ptoken-assistant-guest-logging for more details, Set once only. enum ASSISTANT_SURFACE_RESTRICTION_UNSPECIFIED ASSISTANT_SURFACE_RESTRICTION_GOOGLE_HOME_AADC_LOGGING ASSISTANT_SURFACE_RESTRICTION_VM_ENROLLED_ATV_AADC_LOGGING ASSISTANT_SURFACE_RESTRICTION_DOCKED_LOCKED_TKY_GUEST_LOGGING ASSISTANT_SURFACE_RESTRICTION_ACTION_BLOCKS ASSISTANT_SURFACE_RESTRICTION_VOICE_ACCESS ASSISTANT_SURFACE_RESTRICTION_ROBIN ASSISTANT_SURFACE_RESTRICTION_UNVERIFIABLE_OR_UNENROLLED enumDescriptions Google Home like shared devices (speakers, displays) subject to aadc. go/assistant-aadc-design for details. Voice Match enrolled Android TVs, ATVs without Voice Match are not yet applying AADC. Ref. go/assistant-aadc-tv. Docked and Locked Android based tablets are treated as shared devices and subject to guest logging globally. go/tky-guest-logging for details. Queries from Accessibility app Action blocks on mobile. Refer to go/limit-ab-logs for details. Queries originating from a Voice Access session (type of accessibility feature inside AGA), Refer to go/va-as-logs for details Queries originating from the Assistant with Bard (Robin) application. Refer to go/ptoken-policy-assistant-robin-surface-restriction. Queries originating from an Assistant surface where only biometric identification is available to identify the user, but no enrollment is present. Refer to go/ptoken-policy-assistant-global-guest-logging. type string assistantUserIdentityIsAmbiguous description Whether this request could not be confirmed (through Voice Match (VM), Face Match (FM), etc.) to be coming from the requesting user. This can happen when VM fails, or when VM is not set up on the device. Merge logic is OVERWRITE, see go/aadc-prc for background and implications. type boolean bardRequestTimeUserHistorySetting description Status of a Bard user's history toggle at the request time. See go/bard-history-off-ptoken-policy. Merge logic is `set once`, aka original value wins. See go/bard-user-history-setting-merge. enum HISTORY_SETTING_UNKNOWN HISTORY_SETTING_RETRIEVAL_FAILED HISTORY_SETTING_ON HISTORY_SETTING_OFF enumDescriptions Indicates error in setting retrieval from FACS (either RPC or internal). User allows history to be collected. User does not allow history collecion. type string bitfieldSet format byte type string bitfieldValue description PrivacyContext bitfields value and is set. Values are correlated, but are not combined into submessage to save additional tag in serialized format. See go/ptoken-privacycontext-bitfields For bitfield definition see: google3/privacy/context/proto/privacy_context_bitfield.proto format byte type string datasetProductIds deprecated True description A list of product ids specifies the product association of the dataset. Not to be confused with 'origin_associated_product_id' which specifies the product association of the rpc. This field is used for writes to storage systems that create datasets on the fly as opposed through a schema update/push (e.g. CNS/Napa Express) and should not be used for any other flows. Note that this field is size limited to 4 and it uses a signal value '-1' which represents the dataset is associated with 'AnyProduct'. Merge logic is overwrite, max number of values is 4. See go/datasetattributes-to-prequestcontext-api. items format int32 type integer type array deferredSemanticPurposes description The deferred semantic purposes of the request. See go/processing-purpose-v2?tab=t.0#heading=h.ccv6l1t8rpwz for more details. This field is tighly coupled with the `semantic_purpose` field above, and will only be set if the `semantic_purpose` field is set to the deferred value. items enum SEMANTIC_PURPOSE_UNSPECIFIED SEMANTIC_PURPOSE_SERVICE_DELIVERY SEMANTIC_PURPOSE_LEGAL_OBLIGATION enumDescriptions The semantic purpose is unset To provide and maintain Google services, products and features. To protect Google, our users, and the public. type string type array dma52CrossUseOfferedTogether description Cross use offered together as described by go/dma52-cuot. Set to true if data processing involves a cross-use with services offered together. This field may be unset or explicitly set to false. Both values have the same semantics for policy enforcement, but may result in nuanced handling by the Defaults mechanism; please see go/dma:cuot:clearing for more details. Merge logic is overwrite, aka "latest value wins". type boolean dma52ProcessingType description Used for offline dataset ownership propagation for dma52 as described by go/dma52-dataset-ownership-propagation. Processing systems (such as flume, sqlp etc) will set the value to PROCESSING_TYPE_COPY if they are performing single or multi CPS copies, and will set the value to PROCESSING_TYPE_COMBINATION if they are processing the data and taking ownership of the read data. For DMA5(2), we believe most of offline jobs to perform PROCESSING_TYPE_COMBINATION. Merge logic is overwrite, aka "latest value wins". Note: If the value is unspecified then PROCESSING_TYPE_COMBINATION will be assumed. enum PROCESSING_TYPE_UNSPECIFIED PROCESSING_TYPE_COMBINATION PROCESSING_TYPE_COPY PROCESSING_TYPE_ML_INFERENCE enumDescriptions type string essentialUseConsentState description A user's essential only mode setting. See go/search-eom-ptoken, go/yt-eom-ptoken and proto definition for more details. Merge logic uses max value. enum ESSENTIAL_USE_CONSENT_STATE_UNSPECIFIED ESSENTIAL_USE_CONSENT_STATE_REGION_OUT_OF_SCOPE ESSENTIAL_USE_CONSENT_STATE_APPLICATION_OUT_OF_SCOPE ESSENTIAL_USE_CONSENT_STATE_SIGNED_IN_OUT_OF_SCOPE ESSENTIAL_USE_CONSENT_STATE_UNRESTRICTED ESSENTIAL_USE_CONSENT_STATE_ESSENTIAL_ONLY enumDescriptions The default value, if the consent state is unset. User is not in essential only mode *and* has not explicitly given consent for non-essential uses of activity data. This corresponds to signed-out users from regions not under EOM policies. User is not in essential only mode *and* has not explicitly given consent for non-essential uses of activity data. This corresponds to signed-out users from in-scope region, but from unsupported applications. User is signed in and has given explicit consent when creating an account. See go/yt-eom-signed-in-enum for details. User is not in essential only mode *and* user has explicitly given consent for non-essential uses of activity data. This corresponds to signed-out users from regions under EOM policies. User is in essential only mode, because the user: - has explicitly declined using activity data for non-essential purposes, - or has not made a decision yet (and user is in region under EOM policies, where we treat the user by default as EOM until they consent). Only signed out users from regions under EOM policies are eligible to set this. type string geoLocationLookupStatus description Status of a request routing lookup of GeoLocationRestriction. This field is used by routing services (i.e. Compass/Bearing for Olympus) to indicate a successful lookup or why a lookup failed. enum GEO_LOCATION_LOOKUP_STATUS_UNSPECIFIED GEO_LOCATION_LOOKUP_STATUS_SUCCESS GEO_LOCATION_LOOKUP_STATUS_ESS_FAILURE GEO_LOCATION_LOOKUP_STATUS_HOMEMAP_FAILURE GEO_LOCATION_LOOKUP_STATUS_HOMEMAP_NOT_FOUND GEO_LOCATION_LOOKUP_STATUS_HOMEMAP_MISSING_POLICY GEO_LOCATION_LOOKUP_STATUS_AUTH_FAILURE GEO_LOCATION_LOOKUP_STATUS_RPC_FAILURE GEO_LOCATION_LOOKUP_STATUS_MALFORMED_REQUEST GEO_LOCATION_LOOKUP_STATUS_ESS_NOT_FOUND GEO_LOCATION_LOOKUP_STATUS_TENANT_CONFIG_ERROR GEO_LOCATION_LOOKUP_STATUS_UNKNOWN_CODE_ERROR GEO_LOCATION_LOOKUP_STATUS_EMERGENCY_REDIRECT enumDescriptions No Olympus policy was present in the home map. This can happen because of Storage fail-open. The incoming RPC to the lookup service itself has failed. A routing ID could not be determined because of a problem with the request. Examples include invalid or missing IDs and invalid authentication credentials. The server is expected to reject the request early with a client error (`INVALID_ARGUMENT`, `UNAUTHENTICATED`, `PERMISSION_DENIED`) or an HTTP redirect. An OK response indicates a violation. type string isDarkLaunchRequest description When true, designates that the request is a Search PA-level dark launch request - a special kind of synthetic non user-facing request whose value was derived from some user-facing request to some production server. WARNING: Setting this field to true has far reaching effects on how the production systems handle user-data generated by this request. In general though not always, user-data is NOT written when this field is set to true. IMPORTANT: Given the potential for misuse, it is imperitive you reach out to both ptoken-eng@ and search-dark-launch-team@ before attempting to set this field for some new usecase. See go/ptoken-policy-search-dle for more information. This is unrelated to policy darklaunch, which is controlled by `request_policy_rollout_enforcement_mode`. Merge logic is LOGICAL OR. type boolean isIncognito description Whether the request was made in incognito mode or not. See go/ptoken-policy-iga-incognito. Merge logic is logical OR. type boolean originAssociatedProductId description This is used to represent the Product in which the request originated. Merge logic is overwrite, aka "latest value wins". See go/origin-product-id-accessors and go/dma-stable-ids for more details. format int32 type integer originIsEndUser description Set automatically by systems receiving direct traffic from the end user. Defaults to false, meaning this rpc cannot be directly traced back to an end user request. When merging privacy request contexts, this value will be the result of a logical OR of the combined contexts. This is used for a number of policies, such as DMA 6(9), to identify requests originating from the user. For example, primary store attribution is based on this. See go/request-origin-id-dd for more details. type boolean originLogicalCloudLocation description The originating logical location of the request, used to make data residency / data locality policy enforcement decisions. When accessing data in storage, the originating location of a request can be compared against the stored data's location restriction to prevent operations that would not conform with the storage data's location restriction. As per go/drz-client-location-prc, the oneof structure is approved by the owners of the Data Residency Handling Technical Roadmap Report (go/trr:dataresidency-handling) as a means of allowing this property to be extended to support other forms of logical locations. See go/drz-privacy-context-proposal and go/ptoken-policy-location-restriction. Merge logic is overwrite, aka "latest value wins". enum CLOUD_DATA_RESIDENCY_LOCATION_UNSPECIFIED AFRICA_SOUTH1 ASIA_EAST1 ASIA_EAST2 ASIA_NORTHEAST1 ASIA_NORTHEAST2 ASIA_NORTHEAST3 ASIA_SOUTH1 ASIA_SOUTH2 ASIA_SOUTHEAST1 ASIA_SOUTHEAST2 AU AUSTRALIA_SOUTHEAST1 AUSTRALIA_SOUTHEAST2 CA DE EU EUROPE_CENTRAL2 EUROPE_NORTH1 EUROPE_NORTH2 EUROPE_SOUTHWEST1 EUROPE_WEST1 EUROPE_WEST10 EUROPE_WEST11 EUROPE_WEST12 EUROPE_WEST13 EUROPE_WEST14 EUROPE_WEST2 EUROPE_WEST3 EUROPE_WEST4 EUROPE_WEST5 EUROPE_WEST6 EUROPE_WEST7 EUROPE_WEST8 EUROPE_WEST9 GLOBAL INDIA IT JP ME_CENTRAL1 ME_CENTRAL2 ME_WEST1 NORTHAMERICA_NORTHEAST1 NORTHAMERICA_NORTHEAST2 PROD_AE_FJR_1 PROD_AR_EZE_1 PROD_AU_MEL_1 PROD_AU_SYD_1 PROD_BE_BRU_1 PROD_BG_SOF_1 PROD_BR_GRU_1 PROD_BR_RIO_1 PROD_CA_YUL_1 PROD_CA_YYZ_1 PROD_CH_ZRH_1 PROD_CL_SCL_1 PROD_CO_BOG_1 PROD_CZ_PRG_1 PROD_DE_BER_1 PROD_DE_FRA_1 PROD_DE_HAM_1 PROD_DE_MUC_1 PROD_DK_BLL_1 PROD_ES_MAD_1 PROD_FI_HEM_1 PROD_FI_LPP_1 PROD_FR_LBG_1 PROD_FR_MRS_1 PROD_FR_PAR_1 PROD_GB_LHR_1 PROD_HK_HKG_1 PROD_HU_BUD_1 PROD_ID_CGK_1 PROD_IE_DUB_1 PROD_IL_TLV_1 PROD_IN_BOM_1 PROD_IN_DEL_1 PROD_IN_MAA_1 PROD_IT_MIL_1 PROD_IT_TRN_1 PROD_JP_KIX_1 PROD_JP_NRT_1 PROD_KE_MBA_1 PROD_KR_ICN_1 PROD_MX_QRO_1 PROD_MY_KUL_1 PROD_NG_LOS_1 PROD_NL_AMS_1 PROD_NL_DHR_1 PROD_NL_GRQ_1 PROD_OM_MCT_1 PROD_PH_MNL_1 PROD_PL_WAW_1 PROD_PT_LIS_1 PROD_QA_DIA_1 PROD_RU_LED_1 PROD_RU_SVO_1 PROD_SA_DMM_1 PROD_SE_ARN_1 PROD_SG_SIN_1 PROD_TH_BKK_1 PROD_TW_TPE_1 PROD_TW_TSA_1 PROD_UA_KBP_1 PROD_US_ATL_1 PROD_US_CBF_1 PROD_US_CHS_1 PROD_US_CKV_1 PROD_US_CMH_1 PROD_US_DEN_1 PROD_US_DFW_1 PROD_US_DLS_1 PROD_US_IAD_1 PROD_US_LAS_1 PROD_US_LAX_1 PROD_US_LGA_1 PROD_US_MIA_1 PROD_US_MRN_1 PROD_US_ORD_1 PROD_US_PHX_1 PROD_US_RNO_1 PROD_US_SEA_1 PROD_US_SFO_1 PROD_US_SLC_1 PROD_US_TUL_1 PROD_US_UOS_1 PROD_UY_MVD_1 PROD_ZA_JNB_1 SA SOUTHAMERICA_EAST1 SOUTHAMERICA_WEST1 US US_CENTRAL1 US_CENTRAL1GOOGLE US_CENTRAL2 US_CENTRAL3 US_CENTRAL4 US_CENTRAL5 US_EAST1 US_EAST2 US_EAST3 US_EAST4 US_EAST5 US_EAST7 US_EAST8 US_EAST9 US_SOUTH1 US_WEST1 US_WEST2 US_WEST3 US_WEST4 US_WEST5 US_WEST6 US_WEST7 US_WEST8 AR_ASIA AR_EUROPE AR_US ASIA ASIA1 ASIA2 ASIA_PRIVATE1 BQ_ASIA BQ_EU BQ_US CHC_EU CHC_PREPROD_US CHC_US CLOUD_VISION_EU CLOUD_VISION_US CSTT_EUROPE CSTT_US CTTS_EUROPE CTTS_US DIALOGFLOW_CX_US DLP_ASIA DLP_EUROPE DLP_US DOC_AI_EU DOC_AI_US EUR3 EUR4 EUR5 EUR6 EUR7 EUR8 EUROPE_WEST EUR_NAM1 EUR_PRIVATE1 EVENTARC_ASIA EVENTARC_ASIA1 EVENTARC_EU EVENTARC_EUR3 EVENTARC_EUR4 EVENTARC_NAM4 EVENTARC_NAM5 EVENTARC_US GCE_ASIA GCE_EU GCE_US GCF_ASIA GCF_EUROPE GCF_NON_AXT_ASIA GCF_NON_AXT_EUROPE GCF_NON_AXT_US GCF_US GCS_ASIA GCS_ASIA1 GCS_ASIA_EUROPE_NORTHAMERICA GCS_EU GCS_EUR4 GCS_NAM4 GCS_SOUTHAMERICA GCS_US IP_US KMS_ASIA KMS_ASIA1 KMS_EUR3 KMS_EUR4 KMS_EUR5 KMS_EUR6 KMS_EUR7 KMS_NAM10 KMS_NAM11 KMS_NAM12 KMS_NAM3 KMS_NAM4 KMS_NAM6 KMS_NAM7 KMS_NAM8 KMS_NAM9 KMS_NAM_EUR_ASIA1 NAM10 NAM11 NAM12 NAM13 NAM14 NAM15 NAM2 NAM3 NAM3_LARGE NAM4 NAM5 NAM6 NAM7 NAM8 NAM9 NAM_EUR_ASIA1 NAM_EUR_ASIA2 NAM_EUR_ASIA3 NAM_PRIVATE1 NAM_PRIVATE2 NAM_PRIVATE3 PD_ASIA PD_EU PD_US US_CENTRAL PROD_AE_DXB_1 PROD_AU_BNE_1 PROD_AU_CBR_1 PROD_DE_DUS_1 PROD_DK_CPH_1 PROD_ES_BCN_1 PROD_US_AUS_1 PROD_US_BOS_1 PROD_US_PDX_1 PROD_ZA_CPT_1 PROD_AT_VIE_1 PROD_AU_PER_1 PROD_CA_YVR_1 PROD_CA_YYC_1 PROD_GB_MAN_1 PROD_IN_HYD_1 PROD_JP_NGO_1 PROD_NO_OSL_1 PROD_RO_OTP_1 PROD_US_HOU_1 PROD_US_MCI_1 PROD_US_PHL_1 PROD_US_RDU_1 PROD_US_ROA_1 PROD_US_SAT_1 NORTHAMERICA_SOUTH1 BR CH CL GB ID IL KR PROD_US_FWA_1 SG TW US_EAST10 ASIA_SOUTHEAST3 PROD_US_GUM_1 PROD_DE_HDF_1 EUROPE_NORTH3 EVENTARC_NAM7 PROD_NZ_AKL_1 PROD_US_LNK_1 PROD_GR_ATH_1 PROD_NO_SKE_1 enumDescriptions type string pafEnforcedReturnPolicies description This represents the list of policies that clients' business logic will enforce on the data return path. When a policy is present in this field, pToken engine in the downstream stack will skip its evaluation. It is caller's own responsibility to ensure that the policy is enforced. Merge logic is UNION. See go/dma52-filtering-exception for more details about PAF and how to request PAF approval. items enum UNSPECIFIED AADC_GUEST_LOGGING ADP_ANNOTATION ADS_KIDS ADS_P13N AIPEX_PERSONALIZED_DATA ASSISTANT_GEMINI ASSISTANT_GUEST_RESTRICTIONS AXT_STORAGE_COMPLIANCE CLOUD_LOCATION_RESTRICTION DMA52 FLOGS_SOFT_DELETE FOOTPRINTS_SIGNED_OUT_RESTRICTIONS GCS_POLICY GEO_DATA_INTEGRITY K12_MONETIZATION_PROHIBITION NEED_TO_KNOW_POLICY NO_ADS_ACCESS OLYMPUS OPT_IN_PURPOSE_CONSENT PAYMENTS_PERSONALIZATION_SETTINGS PHOTOS_MINORS_MONETIZATION_PROHIBITION PLX_NO_BROAD_WRITABLE PRODUCT_ASSOCIATION_RESTRICTION SALSA_CRITICAL_STOPGAP_LOG_DELETION SEARCH_ANALYTICS_3P_MEDIA SEARCH_MODEL_TRAINING_PRIVACY_CONTROL SEARCH_SIGNED_OUT_RESTRICTIONS UNICORN_MONETIZATION_PROHIBITION USER_PERSONALIZATION_SETTINGS WORKSPACE_PROCESSING_USER_CONSENT_SETTINGS YOUTUBE_CHILDREN_EDU enumDescriptions Handling AADC guest logging. Adp annotation policy. Ads Kids specific restrictions on data excluding DMA. Ads personalization specific restrictions on data defined in go/ptoken-policy-ads-p13n AIPEX personalized data policy. go/ptoken-aipex-personalized-data Assistant Gemini (previously Bard) specific restrictions on data. Logical policies defined in go/pazl-aadc-ptoken-analysis. Axt Storage Compliance policies restrictions. Cloud Data Residency location restrictions on GCP in-scope end-user data. Article 5(2) of the DMA (go/dma52). Flogs soft delete policy. go/ptoken-flogs-soft-delete-policy Footprints specific restrictions on guest data. GCS Policies. Geo data integrity policy. Monetization related restrictions of use of Dasher's children's (K-12) data. Need to Know policy (processing) Handling No Ads Access requests. go/olympus storage and processing regionalization. Opt-in purpose consent policy. Payments related restrictions based on privacy settings Photos specific limitations on monetization per user minors (users under 18) Plx No Broad Writable policy. Manually-configured restriction on dataset product association. SALSA critical stopgap log deletion policy go/ptoken-stopgap-deletion-policy. Search Analytics 3P Media policy. Search Model Training Privacy Control policy. go/ptoken-dga-smpc Search specific restrictions on signed out users. Monetization related restrictions of use of Dasher's children's (unicorn) data. General user related restrictions based on privacy settings. Workspace processing user consent settings. go/eecc-v2-ptoken-policy Handling Wipeout of YouTube Gaia Data for Edunitube. type string type array poeEnforcedReturnPolicies description This represents the list of policies that a layer in the upstream stack promises to enforce on the data return path to its client. This is mostly about post-read filtering of data, either when returning data or when forwarding it further. When a policy is present in this field, pToken engine in the downstream stack can skip its evaluation. Note on usage: an upstream system should add a promise for a policy only if it also performs the necessary enforcement steps. Merge logic is UNION. See go/promise-of-enforcement for the design. items enum UNSPECIFIED AADC_GUEST_LOGGING ADP_ANNOTATION ADS_KIDS ADS_P13N AIPEX_PERSONALIZED_DATA ASSISTANT_GEMINI ASSISTANT_GUEST_RESTRICTIONS AXT_STORAGE_COMPLIANCE CLOUD_LOCATION_RESTRICTION DMA52 FLOGS_SOFT_DELETE FOOTPRINTS_SIGNED_OUT_RESTRICTIONS GCS_POLICY GEO_DATA_INTEGRITY K12_MONETIZATION_PROHIBITION NEED_TO_KNOW_POLICY NO_ADS_ACCESS OLYMPUS OPT_IN_PURPOSE_CONSENT PAYMENTS_PERSONALIZATION_SETTINGS PHOTOS_MINORS_MONETIZATION_PROHIBITION PLX_NO_BROAD_WRITABLE PRODUCT_ASSOCIATION_RESTRICTION SALSA_CRITICAL_STOPGAP_LOG_DELETION SEARCH_ANALYTICS_3P_MEDIA SEARCH_MODEL_TRAINING_PRIVACY_CONTROL SEARCH_SIGNED_OUT_RESTRICTIONS UNICORN_MONETIZATION_PROHIBITION USER_PERSONALIZATION_SETTINGS WORKSPACE_PROCESSING_USER_CONSENT_SETTINGS YOUTUBE_CHILDREN_EDU enumDescriptions Handling AADC guest logging. Adp annotation policy. Ads Kids specific restrictions on data excluding DMA. Ads personalization specific restrictions on data defined in go/ptoken-policy-ads-p13n AIPEX personalized data policy. go/ptoken-aipex-personalized-data Assistant Gemini (previously Bard) specific restrictions on data. Logical policies defined in go/pazl-aadc-ptoken-analysis. Axt Storage Compliance policies restrictions. Cloud Data Residency location restrictions on GCP in-scope end-user data. Article 5(2) of the DMA (go/dma52). Flogs soft delete policy. go/ptoken-flogs-soft-delete-policy Footprints specific restrictions on guest data. GCS Policies. Geo data integrity policy. Monetization related restrictions of use of Dasher's children's (K-12) data. Need to Know policy (processing) Handling No Ads Access requests. go/olympus storage and processing regionalization. Opt-in purpose consent policy. Payments related restrictions based on privacy settings Photos specific limitations on monetization per user minors (users under 18) Plx No Broad Writable policy. Manually-configured restriction on dataset product association. SALSA critical stopgap log deletion policy go/ptoken-stopgap-deletion-policy. Search Analytics 3P Media policy. Search Model Training Privacy Control policy. go/ptoken-dga-smpc Search specific restrictions on signed out users. Monetization related restrictions of use of Dasher's children's (unicorn) data. General user related restrictions based on privacy settings. Workspace processing user consent settings. go/eecc-v2-ptoken-policy Handling Wipeout of YouTube Gaia Data for Edunitube. type string type array policiesBreakglass description Send breakglass signal for a given policy. Evaluation for policies in "breakglass" status will be DISABLED. Breakglass can be set only with a valid justification, and its usage will be monitored for compliancy purposes. More details about breakglass, requirements to set it and how to do it in go/dma52-prc-breakglass. Note that breakglass is intended to be used only for emergencies when the policy is in LAUNCHED state. For opting out while the policy is in ONGOING_ROLLOUT, see `request_policy_rollout_enforcement_mode`. Merge logic for this field is union set. items enum UNSPECIFIED AADC_GUEST_LOGGING ADP_ANNOTATION ADS_KIDS ADS_P13N AIPEX_PERSONALIZED_DATA ASSISTANT_GEMINI ASSISTANT_GUEST_RESTRICTIONS AXT_STORAGE_COMPLIANCE CLOUD_LOCATION_RESTRICTION DMA52 FLOGS_SOFT_DELETE FOOTPRINTS_SIGNED_OUT_RESTRICTIONS GCS_POLICY GEO_DATA_INTEGRITY K12_MONETIZATION_PROHIBITION NEED_TO_KNOW_POLICY NO_ADS_ACCESS OLYMPUS OPT_IN_PURPOSE_CONSENT PAYMENTS_PERSONALIZATION_SETTINGS PHOTOS_MINORS_MONETIZATION_PROHIBITION PLX_NO_BROAD_WRITABLE PRODUCT_ASSOCIATION_RESTRICTION SALSA_CRITICAL_STOPGAP_LOG_DELETION SEARCH_ANALYTICS_3P_MEDIA SEARCH_MODEL_TRAINING_PRIVACY_CONTROL SEARCH_SIGNED_OUT_RESTRICTIONS UNICORN_MONETIZATION_PROHIBITION USER_PERSONALIZATION_SETTINGS WORKSPACE_PROCESSING_USER_CONSENT_SETTINGS YOUTUBE_CHILDREN_EDU enumDescriptions Handling AADC guest logging. Adp annotation policy. Ads Kids specific restrictions on data excluding DMA. Ads personalization specific restrictions on data defined in go/ptoken-policy-ads-p13n AIPEX personalized data policy. go/ptoken-aipex-personalized-data Assistant Gemini (previously Bard) specific restrictions on data. Logical policies defined in go/pazl-aadc-ptoken-analysis. Axt Storage Compliance policies restrictions. Cloud Data Residency location restrictions on GCP in-scope end-user data. Article 5(2) of the DMA (go/dma52). Flogs soft delete policy. go/ptoken-flogs-soft-delete-policy Footprints specific restrictions on guest data. GCS Policies. Geo data integrity policy. Monetization related restrictions of use of Dasher's children's (K-12) data. Need to Know policy (processing) Handling No Ads Access requests. go/olympus storage and processing regionalization. Opt-in purpose consent policy. Payments related restrictions based on privacy settings Photos specific limitations on monetization per user minors (users under 18) Plx No Broad Writable policy. Manually-configured restriction on dataset product association. SALSA critical stopgap log deletion policy go/ptoken-stopgap-deletion-policy. Search Analytics 3P Media policy. Search Model Training Privacy Control policy. go/ptoken-dga-smpc Search specific restrictions on signed out users. Monetization related restrictions of use of Dasher's children's (unicorn) data. General user related restrictions based on privacy settings. Workspace processing user consent settings. go/eecc-v2-ptoken-policy Handling Wipeout of YouTube Gaia Data for Edunitube. type string type array policiesBreakglassStillEvaluated description Turns on evaluation for a policy in breakglass status. This policy will be evaluated in DARK_LAUNCHED mode, i.e. it will be evaluated and monitored, but the result will not affect enforcement. More details at go/ptoken-breakglass-monitoring. This field has no effect for policies that do not also set the breakglass signal (see `policies_breakglass`). Merge logic is union set. items enum UNSPECIFIED AADC_GUEST_LOGGING ADP_ANNOTATION ADS_KIDS ADS_P13N AIPEX_PERSONALIZED_DATA ASSISTANT_GEMINI ASSISTANT_GUEST_RESTRICTIONS AXT_STORAGE_COMPLIANCE CLOUD_LOCATION_RESTRICTION DMA52 FLOGS_SOFT_DELETE FOOTPRINTS_SIGNED_OUT_RESTRICTIONS GCS_POLICY GEO_DATA_INTEGRITY K12_MONETIZATION_PROHIBITION NEED_TO_KNOW_POLICY NO_ADS_ACCESS OLYMPUS OPT_IN_PURPOSE_CONSENT PAYMENTS_PERSONALIZATION_SETTINGS PHOTOS_MINORS_MONETIZATION_PROHIBITION PLX_NO_BROAD_WRITABLE PRODUCT_ASSOCIATION_RESTRICTION SALSA_CRITICAL_STOPGAP_LOG_DELETION SEARCH_ANALYTICS_3P_MEDIA SEARCH_MODEL_TRAINING_PRIVACY_CONTROL SEARCH_SIGNED_OUT_RESTRICTIONS UNICORN_MONETIZATION_PROHIBITION USER_PERSONALIZATION_SETTINGS WORKSPACE_PROCESSING_USER_CONSENT_SETTINGS YOUTUBE_CHILDREN_EDU enumDescriptions Handling AADC guest logging. Adp annotation policy. Ads Kids specific restrictions on data excluding DMA. Ads personalization specific restrictions on data defined in go/ptoken-policy-ads-p13n AIPEX personalized data policy. go/ptoken-aipex-personalized-data Assistant Gemini (previously Bard) specific restrictions on data. Logical policies defined in go/pazl-aadc-ptoken-analysis. Axt Storage Compliance policies restrictions. Cloud Data Residency location restrictions on GCP in-scope end-user data. Article 5(2) of the DMA (go/dma52). Flogs soft delete policy. go/ptoken-flogs-soft-delete-policy Footprints specific restrictions on guest data. GCS Policies. Geo data integrity policy. Monetization related restrictions of use of Dasher's children's (K-12) data. Need to Know policy (processing) Handling No Ads Access requests. go/olympus storage and processing regionalization. Opt-in purpose consent policy. Payments related restrictions based on privacy settings Photos specific limitations on monetization per user minors (users under 18) Plx No Broad Writable policy. Manually-configured restriction on dataset product association. SALSA critical stopgap log deletion policy go/ptoken-stopgap-deletion-policy. Search Analytics 3P Media policy. Search Model Training Privacy Control policy. go/ptoken-dga-smpc Search specific restrictions on signed out users. Monetization related restrictions of use of Dasher's children's (unicorn) data. General user related restrictions based on privacy settings. Workspace processing user consent settings. go/eecc-v2-ptoken-policy Handling Wipeout of YouTube Gaia Data for Edunitube. type string type array privacyAttributesSetter $ref PrivacyAttributesSetter description The privacy attributes setter contains a hashed representation of the job that have set the latest attributes (e.g. Product ID) in the currentrequest context. More at http://go/privacy-attributes-setters processingPurpose description The actual purpose(s) for which processing is happening. Value & enum copied from ProcessingPurpose proto. Merge logic is take the entire new processing_purpose if present. items enum PROCESSING_PURPOSE_UNSPECIFIED PROCESSING_PURPOSE_NOTHING PROVISION_OF_SERVICE PROVISION_OF_SERVICE_INFRASTRUCTURE ADS_RELATED_PROVISION_OF_SERVICE PRODUCT_PERSONALIZATION CONTEXTUALIZATION REVENUE_GENERATION USER_SUPPORT CLOUD_PROCESSING_INFRASTRUCTURE ACCOUNT_MANAGEMENT USER_COMMUNICATIONS MODEL_TRAINING VERIFICATION_TESTING_VALIDATION DEBUGGING_AND_MONITORING INFRASTRUCTURE_METRICS DATA_RECOVERY BUSINESS_ANALYSIS MARKET_RESEARCH RESEARCH_EXPERIMENTATION TRUST_SAFETY TRUST_SAFETY_ANTI_FRAUD TRUST_SAFETY_ANTI_SPAM TRUST_SAFETY_SECURITY TRUST_SAFETY_ANTI_ABUSE COMPLIANCE_LEGAL_SUPPORT LIMITED_MANUAL_ACCESS COMPLIANCE_LEGAL_SUPPORT_TAKEOUT COMPLIANCE_LEGAL_SUPPORT_TAKEOUT_LEGAL COMPLIANCE_LEGAL_SUPPORT_TAKEOUT_CONSUMER COMPLIANCE_LEGAL_SUPPORT_ELI enumDeprecated False False False False False False False False False False False False False False False False False False False False False False True False False False False False False False False enumDescriptions The processing purpose is unset Data is being processed as part of normal provision of service. Provision of service is in general anything done with user consent, that is visible for the user or impacts the user. DO NOT USE this value for any processing that is used to provide advertising or other revenue generating features specifically related to advertising Data is being accessed as part of normal provision of a multi-tenant infrastructure (e.g., a storage system). Data is being processed to provide advertising or other revenue generation features specifically related to advertising Data is being processed to provide personalization features. Data is being processed to provide contextualization features, excluding ad-related contextualization. Data is being processed to drive revenue that is not related to ads (service related revenue). This category is for any data access that was caused by, pursuant to, or necessary to resolve an interaction with a customer or user that the customer initiated. This processing purpose is configured automatically for applicable requests flowing through GCP infrastructure. Data is processed through Cloud infrastructure that exclusively acts on user instruction. This infrastructure only serves Business Users. Data is being processed to handle a user request to manage their account. Data is being processed to send communications to users. Model training as a processing purpose was introduced for complying with the Search Model training Privacy Control (SMPC) policy: go/smpc-program, go/ptoken-dga-smpc. While this purpose doesn't really represent an end-goal, it was approved by legal and reg affairs and its naming aligns with external conversations and regulatory interest. For questions about this purpose contact pCounsel who/sjz. Processing for debugging or monitoring or somehow related to pure software functionality. Access in order to perform testing, verification, certification, or other routine or pre-launch analysis by using stored user data. This can include regression testing, load testing, unit/integration testing, or other analysis of machine-generated or replayed activity. This is done primarily for routinized, transient evaluation like testing new builds/deployments. Processing for debugging or monitoring or somehow related to pure software functionality - analyzing user data to develop approved features, refactor or improve existing ones, or verify, triage, analyze, troubleshoot, or resolve problems with products and services Any processing for the purpose of understanding how services / products are used by users, including traffic shaping, monitoring etc. Any processing necessary to monitor a service and its performance to maintain product excellence, reliability, service quality, or other technical measures as perceived by a user. The data is being processed to detect, prevent, recover for data loss or corruption (in line with the purpose limitations documented at go/backups-user-data). See also go/dg-classification-backup-data. Perform analysis to set strategy, prioritize features, assess business risks or otherwise use the data to derive insights for the benefits of the company or its product or service offering. This is for any analysis that looks at the existing market across companies / manufacturers, or generates leads, contacts or potential clients or users. This can be either for manual outreach, automatic outreach or internal use. Open-ended or undirected analysis of user data with a clear hypothesis or intended benefit in mind. The data is being processed to protect Google, its users, customers or other stakeholders. This includes manual detection, analysis, remediation, prevention of unacceptable abusive behavior as defined by the terms of service. It also includes actions such as processing to keep accounts safe (such as processing for the purposes of auth or authz) More specific Trust and safety purposes. Processing the data for compliance purposes, legal purpose, law enforcement requests and incident management related to any of these. type string type array requestPolicyEnforcement deprecated True description Requests that a given policy be hard enforced if possible, even when they would not normally be. For example, a policy that's in ONGOING_ROLLOUT mode would perform hard enforcement when present in the list. This is generally set on OTA accounts to permit early testing. items enum UNSPECIFIED AADC_GUEST_LOGGING ADP_ANNOTATION ADS_KIDS ADS_P13N AIPEX_PERSONALIZED_DATA ASSISTANT_GEMINI ASSISTANT_GUEST_RESTRICTIONS AXT_STORAGE_COMPLIANCE CLOUD_LOCATION_RESTRICTION DMA52 FLOGS_SOFT_DELETE FOOTPRINTS_SIGNED_OUT_RESTRICTIONS GCS_POLICY GEO_DATA_INTEGRITY K12_MONETIZATION_PROHIBITION NEED_TO_KNOW_POLICY NO_ADS_ACCESS OLYMPUS OPT_IN_PURPOSE_CONSENT PAYMENTS_PERSONALIZATION_SETTINGS PHOTOS_MINORS_MONETIZATION_PROHIBITION PLX_NO_BROAD_WRITABLE PRODUCT_ASSOCIATION_RESTRICTION SALSA_CRITICAL_STOPGAP_LOG_DELETION SEARCH_ANALYTICS_3P_MEDIA SEARCH_MODEL_TRAINING_PRIVACY_CONTROL SEARCH_SIGNED_OUT_RESTRICTIONS UNICORN_MONETIZATION_PROHIBITION USER_PERSONALIZATION_SETTINGS WORKSPACE_PROCESSING_USER_CONSENT_SETTINGS YOUTUBE_CHILDREN_EDU enumDescriptions Handling AADC guest logging. Adp annotation policy. Ads Kids specific restrictions on data excluding DMA. Ads personalization specific restrictions on data defined in go/ptoken-policy-ads-p13n AIPEX personalized data policy. go/ptoken-aipex-personalized-data Assistant Gemini (previously Bard) specific restrictions on data. Logical policies defined in go/pazl-aadc-ptoken-analysis. Axt Storage Compliance policies restrictions. Cloud Data Residency location restrictions on GCP in-scope end-user data. Article 5(2) of the DMA (go/dma52). Flogs soft delete policy. go/ptoken-flogs-soft-delete-policy Footprints specific restrictions on guest data. GCS Policies. Geo data integrity policy. Monetization related restrictions of use of Dasher's children's (K-12) data. Need to Know policy (processing) Handling No Ads Access requests. go/olympus storage and processing regionalization. Opt-in purpose consent policy. Payments related restrictions based on privacy settings Photos specific limitations on monetization per user minors (users under 18) Plx No Broad Writable policy. Manually-configured restriction on dataset product association. SALSA critical stopgap log deletion policy go/ptoken-stopgap-deletion-policy. Search Analytics 3P Media policy. Search Model Training Privacy Control policy. go/ptoken-dga-smpc Search specific restrictions on signed out users. Monetization related restrictions of use of Dasher's children's (unicorn) data. General user related restrictions based on privacy settings. Workspace processing user consent settings. go/eecc-v2-ptoken-policy Handling Wipeout of YouTube Gaia Data for Edunitube. type string type array requestPolicyRolloutEnforcementMode description Requests a particular enforcement mode for a given policy. Uses a single enum to convey both to minimize payload size. Mapping to and from {LogicalPolicy, EnforcementMode} are provided in the getter and setter apis. Merge logic is union set. These modes only take effect while the policy is in ONGOING_ROLLOUT status. More details in go/dma52-prc-rollout-signals. items enum POLICY_ROLLOUT_ENFORCEMENT_MODE_UNSPECIFIED DMA52_GLOBAL_RAMPUP DMA52_EXPLICIT_OPT_IN DMA52_OPT_OUT DMA52_OPT_OUT_FILTERING DMA52_DISCOVERY_OPT_IN DMA52_WAVE3_EARLY_ENFORCEMENT DMA52_WAVE3_CLIENT_OPT_IN DMA52_WAVE3_INTERNAL_OPT_IN enumDescriptions Enables enforcement on DMA52 policy for systems/dataset that are in the ENFORCEABLE state (see google3/privacy/ptoken/contrib/policy_rollouts/request_context_enforceable_mode_config.proto). Set upstream centrally based on the user bucket (go/policy-rollout-buckets). It works only if the specific DMA 5(2) policy is loaded with ONGOING_ROLLOUT status (check status for your integration in google3/configs/privacy/ptoken/prod/clients/). No effect when policy is in LAUNCHED status. If a FractionalRolloutConfiguration (google3/privacy/ptoken/contrib/policy_rollouts/fractional_enforcement.proto) for DMA52 policy is provided, this signal is ignored. Enables enforcement on DMA52 policy for systems/dataset that are in the EARLY_ENFORCEABLE and ENFORCEABLE states (see google3/privacy/ptoken/contrib/policy_rollouts/request_context_enforceable_mode_config.proto) It works only if the specific DMA 5(2) policy is loaded with ONGOING_ROLLOUT status (check status for your integration in google3/configs/privacy/ptoken/prod/clients/). No effect when policy is in LAUNCHED status. To be set explicitly by callers. Turns off both hard enforcement and AOM for DMA52 policies. It works only if the specific DMA 5(2) policy is loaded with ONGOING_ROLLOUT status (check status for your integration in google3/configs/privacy/ptoken/prod/clients/). No effect when policy is in LAUNCHED status. Downgrades enforcement mode to AOM for DMA52 policies. If the policy is fully launched, or if AOM stage is not reached yet, this value will have no effect. It works only if the specific DMA 5(2) policy is loaded with ONGOING_ROLLOUT status (check status for your integration in google3/configs/privacy/ptoken/prod/clients/). No effect when policy is in LAUNCHED status. Enables enforcement for systems/datasets enabled in DISCOVERY_ENFORCEMENT to explicitly test outside of central control. It works only if the specific DMA 5(2) policy is loaded with ONGOING_ROLLOUT status (check status for your integration in google3/configs/privacy/ptoken/prod/clients/). No effect when policy is in LAUNCHED status. To be set explicitly by callers. Enables enforcement on the Wave 3 DMA 5(2) policy for systems/dataset that are in the EARLY_ENFORCEABLE and ENFORCEABLE states (see google3/privacy/ptoken/contrib/policy_rollouts/request_context_enforceable_mode_config.proto) It works only if the Wave 3 DMA 5(2) policy is loaded with ONGOING_ROLLOUT status (check status for your integration in google3/configs/privacy/ptoken/prod/clients/). No effect when policy is in LAUNCHED status. To be set explicitly by callers. NOTE: Currently, there is no way to set these two signals (DMA52_WAVE3_CLIENT_OPT_IN and DMA52_WAVE3_INTERNAL_OPT_IN). This is intentional, an API to set these will be added soon once the CLs that submitted the new signals are rollback safe. Used for PA experiments and PA-driven rampup. TODO (b/377510871): Make an API to set DMA52_WAVE3_CLIENT_OPT_IN and DMA52_WAVE3_INTERNAL_OPT_IN. Set by Consistent Enforcement API. type string type array searchIsInEmergencyCriticalOnlyMode description DO NOT ALTER THIS ATTRIBUTE STATE without reaching out to Footprints or Kansas teams. Captures whether Search (or more precisely GWS) is in critical-only mode, which is a production disaster mitigation state. This is supported as part of go/search-reliability-code-purple. In more details: controls whether or not non-critical data should be returned to search. When set, it indicates that all non-critical data should be filtered out (based on DGA). Used to mitigate and recover from search outages caused by non-essential data. Populated by a borg flag. See go/ptoken-policy-kansas-filter. Merge logic is logical OR. type boolean semanticPurpose description The semantic purpose of the request. See go/processing-purpose-v2 for details. enum SEMANTIC_PURPOSE_UNSPECIFIED SEMANTIC_PURPOSE_SERVICE_DELIVERY SEMANTIC_PURPOSE_LEGAL_OBLIGATION enumDescriptions The semantic purpose is unset To provide and maintain Google services, products and features. To protect Google, our users, and the public. type string signedOutEpdEligibility description Whether the user is eligible to receive Signed Out ePD treatment, to comply with the ePrivacy Directive (ePD). See go/ptoken-signed-out-epd-eligibility and proto definition for more details. Merge logic uses max value. enum EPD_ELIGIBILITY_UNSPECIFIED EPD_ELIGIBILITY_ELIGIBLE EPD_ELIGIBILITY_NOT_ELIGIBLE_REGION_OUT_OF_SCOPE EPD_ELIGIBILITY_NOT_ELIGIBLE_APPLICATION_OUT_OF_SCOPE EPD_ELIGIBILITY_NOT_ELIGIBLE_SIGNED_IN_OUT_OF_SCOPE enumDescriptions Default unspecified value. The request is in scope for ePD treatment. The request is not eligible for ePD treatment, because it originated from an out of scope country. The request is not eligible for ePD treatment, because the application marked it explicitly as out of scope. The request is not eligible for ePD treatment, because the user is signed-in. Signed-in users are currently always out of scope. type string userSignInState description A user's sign-in status. See go/signin-prc and proto definition for more details. Merge logic uses max value, to keep the request at the most restrictive state encountered. enum USER_SIGN_IN_STATE_UNSPECIFIED USER_SIGN_IN_STATE_SIGNED_OUT USER_SIGN_IN_STATE_SIGNED_IN enumDescriptions type string youtubeAutoplayEmbeddedPlayback description Whether or not this YouTube playback originated from the embedded player with autoplay enabled. Merge logic is LOGICAL OR. See go/youtube-privacy-enhanced-playbacks-ptoken-policy for more details. type boolean youtubePrivacyEnhancedPlayerType description The type of YouTube privacy enhanced player on which the playback occurred. Merge logic is overwrite, or "latest value wins". See go/youtube-privacy-enhanced-playbacks-ptoken-policy for more details. enum YOUTUBE_PRIVACY_ENHANCED_PLAYER_TYPE_UNSPECIFIED YOUTUBE_PRIVACY_ENHANCED_PLAYER_TYPE_PLAYER_FOR_EDUCATION YOUTUBE_PRIVACY_ENHANCED_PLAYER_TYPE_GOOGLE_WORKSPACE YOUTUBE_PRIVACY_ENHANCED_PLAYER_TYPE_PLAYER_FOR_PUBLISHERS YOUTUBE_PRIVACY_ENHANCED_PLAYER_TYPE_PLAYER_FOR_COMMENTS enumDescriptions type string type object PrivacyAttributesSetter description Encapsulates hash of the privacy-related attributes setters. See go/privacy-attributes-setters. Every new field should be prefixed with the nested field definition inside PrivacyContext proto. For example, PrivacyContext.prequest.origin_associated_product_id becomes *prequest_origin_associated_product_id*_setter_job id PrivacyAttributesSetter properties borgRunUid description The Borg Run UID of the job that sent the initial request. format int64 type string customExecutionId description A custom ID to differentiate a job or unit of execution, specified by user code or configuration. Right most 5 bits are used to encode the type of custom_execution_id which is defined by CustomExecutionIDType. For example, value of (58 bits of ID value)(0b00001) represents non borg job run id. format int64 type string passthroughGfeService description The hash of the GFE service name when having a non-positive origin_product_id value (considered as a passthrough case from GFE). Note that definition of passthrough here (all non-positive product ids) is different from the one in go/dma52-multi-tenant-gfe#what-is-a-passthrough-service (where product id is -1), but they are equivalent in GFE binary code, where we skip Product ID setting. The hash is calculated by keeping the most significant 4 bytes of Fingerprint2011. The service name is read by GFE from GFE config files. This field will be set by GFE jobs only to help downstream debugging. format uint32 type integer prequestOriginAssociatedProductIdSetterGfeService description The hash of the GFE service name setting the PRequestContext.origin_product_id. The hash is calculated by keeping the most significant 4 bytes of Fingerprint2011. GFE service name is set by GFE job while setting the Product ID. The service name is read by GFE from GFE config files. This field will be set by GFE jobs only. format uint32 type integer prequestOriginAssociatedProductIdSetterJob description The hash of the borgjob setting the PRequestContext.origin_product_id. The hash is calculated by keeping the most significant 4 bytes of Fingerprint2011. A borgjob is defined by the concatenation of borg_user, job_name and borg_cell_id. format uint32 type integer sourcePipelineGuri description The hash of a guri at the originator pipeline of the request. This is used for go/dma52-rm-processing and other use cases when the client guri is insufficient on its own (such as multi tanent systems). format uint32 type integer type object ProvidedData description Provided data which augments the device action capabilities. Some built-in intents may require additional configuration to be provided. One example could be the list of channels available for the `action.intent.SelectChannel` intent. id ProvidedData properties data additionalProperties description Properties of the object. Contains field @type with type URL. type any description For more details on which provided data types are available, see the individual intent documentations. type object name type string type object ResponseLimits description Size limits on responses. id ResponseLimits properties type object ResponseLoggingParams description Container for information that is used by the clients for per-response logging. This field can be filled by either Assistant Server or S3. Clients MUST NOT use this for any other purposes, such as branching on it. next id: 25 id ResponseLoggingParams properties designedForFamily description Whether or not logging should be handled as a defined_for_family feature. See go/a4k-logging for more details of the legal necessities. type boolean eventId description A unique ID used in Server side logging which can be used to coordinate Client actions to a particular Server response. type string featureVeId description VE ids of the triggered features, used mainly for testing purpose. items format int32 type integer type array firstFeatureVerticalName description The vertical which fulfilled the request. The vertical name comes from the Visual Element produced for this request. To avoid duplicating the VE list in AS and AGSA (and for privacy), we are sending only the vertical string name (instead of the Feature VEID). In case of multiple elements, the vertical comes from the first one produced. See go/opaft. type string followupQueryType description The type of followup query. enum FOLLOWUP_QUERY_TYPE_UNKNOWN FOLLOWUP_QUERY_TYPE_DISAMBIGUATION FOLLOWUP_QUERY_TYPE_FRAME_STATE_STEERING FOLLOWUP_QUERY_TYPE_SCREEN_CONTEXT_STEERING enumDescriptions type string isFollowupQuery description If a query is a followup to a previous query that returned a conversational response. type boolean isMasqueradeModeRequest description True if current request is fulfilled by a device in Masquerade mode (a privacy-improving incognito-style mode that limits logging and personalization -- see go/masquerade and go/masquerade-design for more details). This field is used by S3 to restrict logging to abuse-only. type boolean isOemPartner description True if current request comes from OEM device and is answered by OEM partners. If true, it should comply with 3P partner data policy. See go/assistant-sdk-partner-data for details. type boolean isSensitiveQuery description True if the original query contains sensitive data. Callers should not do archival logging in this case. See go/assistant-limited-logging and go/assistant-partner-sensitive-data for details. type boolean isUnintendedQuery description True if we deemed the query as unintended (go/unintended-suppression-dd). Bit is only set for suppression of logging and should not be used for other purposes (e.g. training). type boolean isYoutubeKidsNonManagedAccountRequest description True if current request involves fetching YouTube Kids content for non_managed_account (adult voice-matched or guests or Unicorn that didn’t set up the app for a dedicated experience), e.g. [play peppa pig on YouTube Kids]. If true logging of audio in S3 will not happen. go/ytk-logging for details. type boolean musicDisambiguationAnnotation $ref DisambiguationAnnotation description The disambiguation annotations from Sophia music dialog. See go/sophia-music-logging for details. requestContext $ref PRequestContext description Privacy context used for fulfilling of this request. responseErrorMessage description The additional error message when the response is not successful. type string responseIndex description Position of the given response among all responses of the request. Only set in the multiple responses flow. See http://go/assistant-multiple-response format int32 type integer responseReason enum UNKNOWN_RESPONSE_REASON SUCCESS ASSISTANT_SERVER_PUNT ASSISTANT_SERVER_TIME_OUT ASSISTANT_SERVER_NOT_REACHABLE ASSISTANT_SERVER_INTERNAL_ERROR MULTI_HOTWORD_ARBITRATION_REJECTED HOTWORD_MISTRIGGER BAD_REQUEST enumDescriptions Indicates the server was able to handle the request and the response is a successful response. Indicates the server was not capable to handle the request and the response is a punt response. The server timed out on handling the request. The server is not reachable at the moment. The server met internal error when handling the request. The server determined that the client is not selected in the multi-hotword arbitration. The server determined that the request is from a client whose hotword was mis-triggered. Catch-all category for what in HTTP would be a 400-class response code, and in AGSA might be termed "Not Google's Fault." That is, this response code indicates that we did not provide the user a satisfactory response, but do not regret that. HOTWORD_MISTRIGGER is an example of this category of error. This particular enum value is for requests that do not have any more-specific ResponseReason defined. type string serverHotwordInfo $ref ServerHotwordInfo serverSuppressionInfo $ref ServerSuppressionInfo description Additional details why we deemed the query as unintended. Only present if "is_unintended_query" is set to "true". sherlogUrl type string soundSearchHasNoResults description Whether a Sound Search returned no results. type boolean youtubeAssistantFeatureLog description Feature log for model training for YouTube Assistant. These features are be collected from backends like Superroot, passed to Voz InnerTube server via Voz Fulfillment server and Voz server, and logged to YouTubeGWSLogNewSession (processed_youtube.all.sessions). See go/ytm-voice-training-data-logging for detail. items $ref YouTubeAssistantFeatureLogEntry type array youtubeImpressions description Impressions for the youtube client to copy to YouTubeGWSLogEntryProto.Impression if applicable. Used by go/counterfactuals-for-voz for YouTube Assistant. items $ref YoutubeImpression type array youtubeMusicQueryInfo $ref MusicQueryInfo description Query intent logging for music. go/ytm-broad-query-experiments type object ResultInfo description The information about the result candidate. id ResultInfo properties musicTrackData $ref MusicTrackData type object RoutineCapability description Identifies whether or not a device model supports routines. id RoutineCapability properties supportsReconnect description Indicates that the client supports sequential execution of routines. type boolean type object SecurityConfig description Encapsulates security configuration for a single intent of a device model. id SecurityConfig properties authMechanismForRemoteRequests description Specifies auth mechanism to be used upon remote request for device action. enum NONE ENABLED FINGERPRINT_OR_PASSWORD PIN enumDeprecated False False True True enumDescriptions Indicates that auth is not required. Indicates that auth is required. Auth mechanism used is determined automatically at query time, based on various factors such as device type, user settings, etc. Use fingerprint, with fallback to Google account password if fingerprint capabilities are not available on personal device. Note: explicit configuration of specific auth mechanism is being deprecated. Prompt for pin, sent to cloud for validation. Note: explicit configuration of specific auth mechanism is being deprecated. type string type object ServerHotwordInfo description Add information about server hotword decision. Server Hotword enables decoding the full preamble+query audio in hotword triggered queries. By enabling decoding preamble+main audio, server hotword checks if a hotword phrase is detected in the top hypothesis. This signal may be used to suppress the request on client. While for most hotword triggered queries, server runs server_hotword, it's upto the client to use or ignore the signal when preparing the response. unintended_query_filter.gcl dictates for which clients server hotword is used to suppress the query or not. Even if server hotword result is not used to suppress, logging this information is useful for tracking the client hotword performance. Enum HOTWORD_MISTRIGGER ResponseReason above isn't currently used, but it is meant to set based on the action taken for the query. E.g. if the server_hotword doesn't find hotword, but client ignores the server hotword result, response_reason will not be set to HOTWORD_MISTRIGGER. (This is similar to HOTWORD_MISTRIGGER in ResponseForInvalidRequest - https://cs.corp.google.com/piper///depot/google3/assistant/api/conversation.proto?type=cs&q=+hotword_mistrigger&g=0&l=350&rcl=254451652 ) id ServerHotwordInfo properties result enum NOT_SET SERVER_HOTWORD_VALIDATED SERVER_HOTWORD_INVALIDATED enumDescriptions Hotword validation is not done in speech recognition server. Hotword was found by the speech recognition server. Hotword was not found by the speech recognition server. type string status enum UNKNOWN SERVER_HOTWORD_DISABLED SERVER_HOTWORD_ENABLED enumDescriptions Hotword validation is either not done or if done, is not used to suppress the query. It is the case when either unintended_query_filter or server_hotword check is not enabled. Defined at https://cs.corp.google.com/piper///depot/google3/googledata/experiments/assistant_server/features/unintended_query_filter.gcl?type=cs&g=0&l=18&rcl=248775811 Hotword validation is done on the speech recognition server AND the result is used to decide if the query should be suppressed or not. type string type object ServerSuppressionInfo description Contains additional information which of the existing server-side suppression mechanisms caused the query to be suppressed. Used for breaking down and logging client-side undertriggering. id ServerSuppressionInfo properties suppressedByHotword description Whether the query was suppressed because of the hotword invalidation signal. type boolean suppressedByLph description Whether the query was suppressed by the Long-Press-Home (LPH) filtering model. type boolean suppressedByPqrnnModel description Whether the query was suppressed by any of the existing semantic models (pQRNN, Ranklab, speech-aware model). type boolean suppressedByRanklabModel type boolean suppressedBySpeechAwareModel type boolean type object SignInMethod description The method of sign in which the client supports. id SignInMethod properties method enum UNSPECIFIED NOT_ALLOWED PHONE_APP ON_DEVICE_MENU WEB_APP enumDescriptions Unspecified value. Defaults to the same sign-in behavior as `PHONE_APP`. Sign in is not allowed. Sign in with Home app, e.g. Google Home. Sign in with on device menu, e.g. LGTV. Sign in with the Assistant sign in website. type string signInRequired description Make Google sign-in mandatory for using Google Assistant on the device. type boolean type object SliderProperties description All the information provided for the slider actions like max_level of slider or so. These will be used as markers to indicate slider properties and we do not issue command with param values beyond the limit. id SliderProperties properties maxValue description Max value of the slider levels that device understands. If it can only be set/unset and works like toggle then set this value to 1. format int32 type integer type object TimerCapability description Capability with regard to support of timers by the client. id TimerCapability properties maxSupportedTimers description Maximum number of timers that can be created on the client. Zero or unset indicates no maximum limit. format int32 type integer type object TraitConfig description Domain specific capabilities regarding traits. id TraitConfig properties attributes additionalProperties type any description The default attributes to be registered in this device for this trait. For example, `{"colorModel": "rgb"}` could designate the color model to use for the ColorSetting trait. The attributes will control the behavior of the traits, and different traits depend on different sets of attributes. The attributes for a specific device owned by the user may be overridden by the device instance registration. For the list of traits and their associated attributes, see https://developers.google.com/assistant/sdk/reference/traits/. type object type object VisualOutputCapability description Manages visual experience of the device model, including HTML related features. id VisualOutputCapability properties backButtonKeycode description The keyCode of the Back button on TV's remote control. format int32 type integer dimensions $ref Dimensions description Device dimensions. style description Specifies the visual output style for this device model. enum UNSPECIFIED HTML_TV TEXT CONCISE_TEXT enumDescriptions No visual experience is provided. Give visual output in HTML5 format, suitable for TV. Give plain text as output. Concise text responses that can be used, for example, on wearables with small screens. type string supportsPersistentDisplay description Identifies whether or not a device model supports a persistent display. type boolean supportsShowSuggestions description Enable suggestions as possible follow on queries generated by the Assistant. For example a user query of "what is weather today?" might generate a suggestion for "what about tomorrow?" or "how about this weekend?". If `VisualOutputCapability.Style.HTML_TV` is enabled, suggestions are already returned inside the HTML payload. If `supports_show_suggestions` is also set, the same suggestions will be returned outside the HTML payload. type boolean supportsWeatherDisplay description Identifies whether or not a device model supports displaying weather query results. type boolean usesSeparateFullViewer description If set, it indicates that the client needs to open a separate full viewer, e.g., a full HTML browser/webview, to handle visual results in `AssistResponse` with `viewer_type = FULL_VIEWER`, i.e., those require more resources to render or will trigger interactions that need full browser functions. If set, the Google Assistant backend may decide to return such visual results with content that better fit a full viewer, e.g., putting photos in full screen in the HTML markup. type boolean type object WifiCallingCapability description Identifies whether or not a device model has wifi calling capability. id WifiCallingCapability properties supportWifiCalling type boolean type object YouTubeAssistantFeatureLogEntry description Feature log for model training for YouTube voice queries. id YouTubeAssistantFeatureLogEntry properties tag description The string tag is used to distinguish logs from different systems. For example, "superroot top result model", "song ranking in mix server", etc. This field will be populated in Voz. items type string type array youtubeSuperrootQueryLevelFeatures $ref YouTubeSuperrootQueryLevelFeatures description Query level features. youtubeSuperrootResultLevelFeatures description One ResultLevelFeatures proto per result. The result does not have to be shown to the user. items $ref YouTubeSuperrootResultLevelFeatures type array type object YouTubeSuperrootQueryLevelFeatures description Next ID: 5 id YouTubeSuperrootQueryLevelFeatures properties hasMusicPremiumAccess description Whether the user has YouTube Music premium access. type boolean isEntitySeekingQuery description Whether the query is an entity seeking query (e.g. looking for a song). type boolean queryBroadnessScore description A score for how much the query is broad (instead of navigational). format float type number type object YouTubeSuperrootResultLevelFeatures description Next ID: 42 id YouTubeSuperrootResultLevelFeatures properties auisScoreQuery description AUIS (Assistant User Interaction Score) features of the (query, result) pair. There are multiple levels of granularities when getting AUIS feature for the request and result. Using (query, result) as key. format float type number auisScoreQueryLanguage description Using (query, language, result) as key. format float type number auisScoreQueryLanguageCountry description Using (query, language, country, result) as key. format float type number instantNavboostImpressions description See go/yt-instant-nb-g3doc for docs on YouTube Navboost/instant Navboost. format float type number instantNavboostTrad format float type number isEntityMatch description Whether there is an entity match between the query and document. type boolean isMusicOfficialContent description Whether the content is official (e.g. an official ATV). type boolean isMusicPaygatedContent description Whether the content is a paygated. type boolean isYoutubeMusicTopResult description YouTube Music only. Whether this result is the top result. This field will be populated in Voz. type boolean matchesAssistantIntentIsCollection description Whether the result type matches Assistant primary intent. "_is_collection" means we only distinguish whether the intent or result is a collection (playlist, album, artist) or a single video/ATV. "_type" means the type (video/ATV, playlist, album, artist). "_mid" means the mid associated with the result matches the mid in Assistant intent. type boolean matchesAssistantIntentMid type boolean matchesAssistantIntentType type boolean musicCombinedFeatureboostCpi description See go/featureboost-public for docs on YouTube Featureboost. YouTube Music "Combined Featureboost" means we attribute user activities on the top result to the original shelf they originally come from. This solves some oscillating problem of original Featureboost values. This is shelf Featureboost, not result level. format float type number musicCombinedFeatureboostDvq format float type number musicCombinedFeatureboostNumWatches format float type number musicCombinedFeatureboostRdp format float type number musicIrNoP13n description IR (information retrieval) score for the document. We will multiply some personalized factor to the IR score in Twiddler. "no_p13n" means the IR score without this tweak. format float type number musicResultType description Result type, e.g. SONG, VIDEO, PLAYLIST. See google3/video/youtube/search/alexandria/proto/youtube_music_info.proto type string navboostImpressionFrac format float type number navboostImpressions format float type number navboostLccFrac format float type number navboostTrad format float type number p13nArtistScore description P13n signals. Some of them are produced by other models. format float type number p13nCtr format float type number p13nCwt format float type number p13nLogEwt format float type number p13nPlaylistListenCount format int32 type integer p13nWatches format int32 type integer queryMatchTitleRatio description If title contains query, the ratio of query length / title length. Else 0. For example, if query = "Adele" and title = "Adele - Rolling in the Deep (Official Music Video)", then this feature is 1 / 8. format float type number topResultModelScore description The score of the result as determined by the top result model. format float type number tstar description go/tstar. Roughly a relevance score of the document and the query. format float type number url description The URL of the result. Contains video ID (if there) and playlist ID (if there). This field will be populated in Voz. type string watchboostCpi description See go/watchboost for information on YouTube Watchboost. Contains aggregated engagement information for videos. format float type number watchboostDvq format float type number watchboostImpressions format float type number watchboostNumClicks format float type number watchboostRdp format float type number youtubeDurationInSeconds description Length of the video. format int32 type integer youtubeMusicTopResultTriggerLogic description The final selection logic for the top result. There are results not selected by the model. enum TOP_RESULT_TRIGGER_LOGIC_UNKNOWN ALLOWLIST MY_MIX PRESELECT_HIGH_DVQ ARTIST_MIX_INTENT GENRE_MIX_MATCH_GENRE_QUERY PLAYLIST_HIGH_DVQ QUERY_MIX_MATCH_GENRE_QUERY_OR_KEY_WORDS TWIDDLER_ANNOTATION QUERY_SIGNAL FALLBACK_DOC_TRUST PRESELECT_PMV_LOW_DVQ GENRE_MIX_NOT_MATCH_GENRE_QUERY QUERY_MIX_NOT_MATCH_CONDITIONS PLAYLIST_LOW_DVQ FALLBACK_DVQ FALLBACK_IR_SCORE ARTIST_SWAP_TO_STATION CURATED_PLAYLIST SWAP_VIDEO_WITH_ATV TOPICAL_MIX HIGH_QUALITY_NEW_ALBUM ASSISTANT_SIGNAL BROAD_VOICE_PLAYLIST MODEL_BASED_SCORE LISTENED_PLAYLIST LIKED_SONGS_PLAYLIST ATTRIBUTE_RADIO ASSISTANT_INTENT_TYPE_TOP_RESULT_MODEL FALLBACK_ALBUM RANKED_RADIO ATV_VERSION_SWAP ASSISTANT_EXPLICIT_INTENT_TYPE MODEL_BASED_SCORE_RANDOMIZATION HEURISTIC_PODCAST_SHOW_USING_SHOW_ENTITY ALBUM_QUERY_TOP_RESULT_MODEL RECAP_PLAYLIST TRIGGERING_WORDS_PODCAST_SHOW_HEURISTIC QUS_PODCAST_SHOW_HEURISTIC EPISODES_PODCAST_SHOW_HEURISTIC YTKS_PODCAST_SHOW_HEURISTIC OFFLINE_LLM_RESPONSE ARTIST_QUERY_TOP_RESULT_MODEL SELECTED_EPISODE_VIDEO_FROM_SHOW enumDeprecated False False False False False False False False False False False False False False False False False False False False False False False True False False False False False False False False False False False False False False False False False False False False enumDescriptions Top result isn't setted. Top result is selected from allowlist. Play some music use case. Top result is selected from a pre-check on PMV using a high_threshold dvq. Top result is selected based on artist mix intent. Top result is selected from genre mix matching genre query mid. Top result is selected from playlist with a high_threshold dvq. Top result is selected from query mix matching genre query mid or query contains mix triggering keywords. Top result is selected from a twiddler annotated result, e.g. latest twiddler. Top result is selected based on query signals. Top result is selected using trust based fallback. Top result is selected from a pre-check on PMV using a low_threshold dvq. Top result is selected from genre mix without match conditions. Top result is selected from query mix without match conditions. Top result is selected from a low-threshold dvq check on playlists. Top result is selected using highest dvq within response. Top result is selected based on highest IR score within response. Top result selected based on Curated station presence for genre/query intent. Prefer ATV matching the video if the video is the top result and there exist a linked atv. Top result selected from topical mix Top result is selected from predicted high quality new album. Top result selected based on Assistant signals. Top result is a randomized playlist chosen for broad voice queries. Top result selected based on ranking results from various shelf directly. Top result based on user listened playlist. Top result selected from Liked Songs Playlist. Top result selected from Attribute Radio. Top result selected with top result model from content types matching Assistant intent type. Top result album fallback if no other album is selected. To result selection from the ranked radios/mixes Swap ATV to a better version, e.g. non canonical version swapped to studio version. Top result selected based on explicit intent type in Assistant intent. E.g. the user explicitly said the word "album" in the query. Top Result selected randomly from top N results based on top result model. Top result is selected using kg mid corresponding to a KG podcast show For album queries, top result will be selected from albums only using Top Result Model. Top result selected from Recap Playlist. A podcast show is promoted for queries with specific triggering words (e.g. "podcasts") A podcast show is promoted for queries with specific QUS signals A podcast show linked to results in the podcast episodes response is promoted to top result A podcast show related to a QUS KG mid is identified and selected using YTKS Response presented from LLM which was pre-computed for this query. For artist queries, top result will be selected from artists only using Top Result Model. When a podcast show playlist is the candidate for Top Result, and there is an episode selected for the user by GetSelectedEpisodeDocid(), then that selected episode video replaces the show and becomes the Top Result. Currently, the selected episode is the last unfinished episode of the show. type string youtubeMusicTopResultTriggerLogicBeforeMutators enum TOP_RESULT_TRIGGER_LOGIC_UNKNOWN ALLOWLIST MY_MIX PRESELECT_HIGH_DVQ ARTIST_MIX_INTENT GENRE_MIX_MATCH_GENRE_QUERY PLAYLIST_HIGH_DVQ QUERY_MIX_MATCH_GENRE_QUERY_OR_KEY_WORDS TWIDDLER_ANNOTATION QUERY_SIGNAL FALLBACK_DOC_TRUST PRESELECT_PMV_LOW_DVQ GENRE_MIX_NOT_MATCH_GENRE_QUERY QUERY_MIX_NOT_MATCH_CONDITIONS PLAYLIST_LOW_DVQ FALLBACK_DVQ FALLBACK_IR_SCORE ARTIST_SWAP_TO_STATION CURATED_PLAYLIST SWAP_VIDEO_WITH_ATV TOPICAL_MIX HIGH_QUALITY_NEW_ALBUM ASSISTANT_SIGNAL BROAD_VOICE_PLAYLIST MODEL_BASED_SCORE LISTENED_PLAYLIST LIKED_SONGS_PLAYLIST ATTRIBUTE_RADIO ASSISTANT_INTENT_TYPE_TOP_RESULT_MODEL FALLBACK_ALBUM RANKED_RADIO ATV_VERSION_SWAP ASSISTANT_EXPLICIT_INTENT_TYPE MODEL_BASED_SCORE_RANDOMIZATION HEURISTIC_PODCAST_SHOW_USING_SHOW_ENTITY ALBUM_QUERY_TOP_RESULT_MODEL RECAP_PLAYLIST TRIGGERING_WORDS_PODCAST_SHOW_HEURISTIC QUS_PODCAST_SHOW_HEURISTIC EPISODES_PODCAST_SHOW_HEURISTIC YTKS_PODCAST_SHOW_HEURISTIC OFFLINE_LLM_RESPONSE ARTIST_QUERY_TOP_RESULT_MODEL SELECTED_EPISODE_VIDEO_FROM_SHOW enumDeprecated False False False False False False False False False False False False False False False False False False False False False False False True False False False False False False False False False False False False False False False False False False False False enumDescriptions Top result isn't setted. Top result is selected from allowlist. Play some music use case. Top result is selected from a pre-check on PMV using a high_threshold dvq. Top result is selected based on artist mix intent. Top result is selected from genre mix matching genre query mid. Top result is selected from playlist with a high_threshold dvq. Top result is selected from query mix matching genre query mid or query contains mix triggering keywords. Top result is selected from a twiddler annotated result, e.g. latest twiddler. Top result is selected based on query signals. Top result is selected using trust based fallback. Top result is selected from a pre-check on PMV using a low_threshold dvq. Top result is selected from genre mix without match conditions. Top result is selected from query mix without match conditions. Top result is selected from a low-threshold dvq check on playlists. Top result is selected using highest dvq within response. Top result is selected based on highest IR score within response. Top result selected based on Curated station presence for genre/query intent. Prefer ATV matching the video if the video is the top result and there exist a linked atv. Top result selected from topical mix Top result is selected from predicted high quality new album. Top result selected based on Assistant signals. Top result is a randomized playlist chosen for broad voice queries. Top result selected based on ranking results from various shelf directly. Top result based on user listened playlist. Top result selected from Liked Songs Playlist. Top result selected from Attribute Radio. Top result selected with top result model from content types matching Assistant intent type. Top result album fallback if no other album is selected. To result selection from the ranked radios/mixes Swap ATV to a better version, e.g. non canonical version swapped to studio version. Top result selected based on explicit intent type in Assistant intent. E.g. the user explicitly said the word "album" in the query. Top Result selected randomly from top N results based on top result model. Top result is selected using kg mid corresponding to a KG podcast show For album queries, top result will be selected from albums only using Top Result Model. Top result selected from Recap Playlist. A podcast show is promoted for queries with specific triggering words (e.g. "podcasts") A podcast show is promoted for queries with specific QUS signals A podcast show linked to results in the podcast episodes response is promoted to top result A podcast show related to a QUS KG mid is identified and selected using YTKS Response presented from LLM which was pre-computed for this query. For artist queries, top result will be selected from artists only using Top Result Model. When a podcast show playlist is the candidate for Top Result, and there is an episode selected for the user by GetSelectedEpisodeDocid(), then that selected episode video replaces the show and becomes the Top Result. Currently, the selected episode is the last unfinished episode of the show. type string youtubeMusicUrlBeforeMutators description "Mutators" are the additional processing steps after the Top Result Model, e.g. it can switch an artist result to an artist radio, and switch between OMVs with ATVs. Info of result right after the Top Result Model, before the mutators. type string type object YoutubeImpression id YoutubeImpression properties intArg description Copied to YouTubeGWSLogEntryProto.Impression.IntArgs format int32 type integer tag description Human readable text, not a serialized proto. Copied to YouTubeGWSLogEntryProto.Impression.Tag type string textArg description Human readable text, not a serialized proto. Copied to YouTubeGWSLogEntryProto.Impression.TextArgs type string type object servicePath title Google Assistant API version v1beta1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/endpointidentityca-pa-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/endpointidentityca-pa-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/enterprisepurchasing-	values_changed root['revision'] new_value 20250205 old_value 20250127
prod/enterprisepurchasing-v1	values_changed root['revision'] new_value 20250205 old_value 20250127
prod/enterprisepurchasing-v1alpha	values_changed root['revision'] new_value 20250205 old_value 20250127
prod/eu-dialogflow-	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/eu-dialogflow-v1	values_changed root['revision'] new_value 20250207 old_value 20250128
prod/eu-dialogflow-v2	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250207 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/eu-dialogflow-v2beta1	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/eu-dialogflow-v3	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/eu-dialogflow-v3alpha1	values_changed root['revision'] new_value 20250207 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/eu-dialogflow-v3beta1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/eu-discoveryengine-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/eu-discoveryengine-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/eu-discoveryengine-v1alpha	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/eu-discoveryengine-v1beta	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/eu-enterpriseknowledgegraph-v1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://enterpriseknowledgegraph.googleapis.com/ batchPath batch canonicalName Enterpriseknowledgegraph description discoveryVersion v1 documentationLink https://cloud.google.com/enterprise-knowledge-graph fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id enterpriseknowledgegraph:v1 kind discovery#restDescription mtlsRootUrl https://enterpriseknowledgegraph.mtls.googleapis.com/ name enterpriseknowledgegraph ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources locations resources publicKnowledgeGraphEntities methods lookup description Finds the public KG entities with public KG ID(s). flatPath v1/locations/{locationsId}/publicKnowledgeGraphEntities:Lookup httpMethod GET id enterpriseknowledgegraph.locations.publicKnowledgeGraphEntities.lookup parameterOrder parent parameters ids description Required. The list of entity ids to be used for lookup. location query repeated True type string languages description The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'. location query repeated True type string parent description Required. The name of the Entity's parent resource. Format: `projects/{project}/locations/{location}` location path pattern ^locations/[^/]+$ required True type string path v1/{+parent}/publicKnowledgeGraphEntities:Lookup response $ref GoogleCloudEnterpriseknowledgegraphV1LookupPublicKgResponse scopes https://www.googleapis.com/auth/cloud-platform projects resources locations resources cloudKnowledgeGraphEntities methods lookup description Finds the Cloud KG entities with CKG ID(s). flatPath v1/projects/{projectsId}/locations/{locationsId}/cloudKnowledgeGraphEntities:Lookup httpMethod GET id enterpriseknowledgegraph.projects.locations.cloudKnowledgeGraphEntities.lookup parameterOrder parent parameters ids description Required. The list of entity ids to be used for lookup. location query repeated True type string languages description The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'. location query repeated True type string parent description Required. The name of the Entity's parent resource. Format: `projects/{project}/locations/{location}` location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+parent}/cloudKnowledgeGraphEntities:Lookup response $ref GoogleCloudEnterpriseknowledgegraphV1LookupResponse scopes https://www.googleapis.com/auth/cloud-platform search description Searches the Cloud KG entities with entity name. flatPath v1/projects/{projectsId}/locations/{locationsId}/cloudKnowledgeGraphEntities:Search httpMethod GET id enterpriseknowledgegraph.projects.locations.cloudKnowledgeGraphEntities.search parameterOrder parent parameters languages description The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'. location query repeated True type string limit description Limits the number of entities to be returned. format int32 location query type integer parent description Required. The name of the Entity's parent resource. Format: `projects/{project}/locations/{location}` location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string query description Required. The literal query string for search. location query type string types description Restricts returned entities with these types, e.g. Person (as defined in `https://schema.org/Person`). If multiple types are specified, returned entities will contain one or more of these types. location query repeated True type string path v1/{+parent}/cloudKnowledgeGraphEntities:Search response $ref GoogleCloudEnterpriseknowledgegraphV1SearchResponse scopes https://www.googleapis.com/auth/cloud-platform entityReconciliationJobs methods cancel description Cancels a EntityReconciliationJob. Success of cancellation is not guaranteed. flatPath v1/projects/{projectsId}/locations/{locationsId}/entityReconciliationJobs/{entityReconciliationJobsId}:cancel httpMethod POST id enterpriseknowledgegraph.projects.locations.entityReconciliationJobs.cancel parameterOrder name parameters name description Required. The name of the EntityReconciliationJob resource. Format: `projects/{project}/locations/{location}/entityReconciliationJobs/{entity_reconciliation_job}` location path pattern ^projects/[^/]+/locations/[^/]+/entityReconciliationJobs/[^/]+$ required True type string path v1/{+name}:cancel request $ref GoogleCloudEnterpriseknowledgegraphV1CancelEntityReconciliationJobRequest response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform create description Creates a EntityReconciliationJob. A EntityReconciliationJob once created will right away be attempted to start. flatPath v1/projects/{projectsId}/locations/{locationsId}/entityReconciliationJobs httpMethod POST id enterpriseknowledgegraph.projects.locations.entityReconciliationJobs.create parameterOrder parent parameters parent description Required. The resource name of the Location to create the EntityReconciliationJob in. Format: `projects/{project}/locations/{location}` location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+parent}/entityReconciliationJobs request $ref GoogleCloudEnterpriseknowledgegraphV1EntityReconciliationJob response $ref GoogleCloudEnterpriseknowledgegraphV1EntityReconciliationJob scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a EntityReconciliationJob. It only deletes the job when the job state is in FAILED, SUCCEEDED, and CANCELLED. flatPath v1/projects/{projectsId}/locations/{locationsId}/entityReconciliationJobs/{entityReconciliationJobsId} httpMethod DELETE id enterpriseknowledgegraph.projects.locations.entityReconciliationJobs.delete parameterOrder name parameters name description Required. The name of the EntityReconciliationJob resource. Format: `projects/{project}/locations/{location}/entityReconciliationJobs/{entity_reconciliation_job}` location path pattern ^projects/[^/]+/locations/[^/]+/entityReconciliationJobs/[^/]+$ required True type string path v1/{+name} response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform get description Gets a EntityReconciliationJob. flatPath v1/projects/{projectsId}/locations/{locationsId}/entityReconciliationJobs/{entityReconciliationJobsId} httpMethod GET id enterpriseknowledgegraph.projects.locations.entityReconciliationJobs.get parameterOrder name parameters name description Required. The name of the EntityReconciliationJob resource. Format: `projects/{project}/locations/{location}/entityReconciliationJobs/{entity_reconciliation_job}` location path pattern ^projects/[^/]+/locations/[^/]+/entityReconciliationJobs/[^/]+$ required True type string path v1/{+name} response $ref GoogleCloudEnterpriseknowledgegraphV1EntityReconciliationJob scopes https://www.googleapis.com/auth/cloud-platform list description Lists Entity Reconciliation Jobs. flatPath v1/projects/{projectsId}/locations/{locationsId}/entityReconciliationJobs httpMethod GET id enterpriseknowledgegraph.projects.locations.entityReconciliationJobs.list parameterOrder parent parameters filter description An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. location query type string pageSize description The standard list page size. format int32 location query type integer pageToken description The standard list page token. location query type string parent description Required. The name of the EntityReconciliationJob's parent resource. Format: `projects/{project}/locations/{location}` location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+parent}/entityReconciliationJobs response $ref GoogleCloudEnterpriseknowledgegraphV1ListEntityReconciliationJobsResponse scopes https://www.googleapis.com/auth/cloud-platform publicKnowledgeGraphEntities methods lookup description Finds the public KG entities with public KG ID(s). flatPath v1/projects/{projectsId}/locations/{locationsId}/publicKnowledgeGraphEntities:Lookup httpMethod GET id enterpriseknowledgegraph.projects.locations.publicKnowledgeGraphEntities.lookup parameterOrder parent parameters ids description Required. The list of entity ids to be used for lookup. location query repeated True type string languages description The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'. location query repeated True type string parent description Required. The name of the Entity's parent resource. Format: `projects/{project}/locations/{location}` location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+parent}/publicKnowledgeGraphEntities:Lookup response $ref GoogleCloudEnterpriseknowledgegraphV1LookupPublicKgResponse scopes https://www.googleapis.com/auth/cloud-platform search description Searches the public KG entities with entity name. flatPath v1/projects/{projectsId}/locations/{locationsId}/publicKnowledgeGraphEntities:Search httpMethod GET id enterpriseknowledgegraph.projects.locations.publicKnowledgeGraphEntities.search parameterOrder parent parameters languages description The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'. location query repeated True type string limit description Limits the number of entities to be returned. format int32 location query type integer parent description Required. The name of the Entity's parent resource. Format: `projects/{project}/locations/{location}` location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string query description Required. The literal query string for search. location query type string types description Restricts returned entities with these types, e.g. Person (as defined in `https://schema.org/Person`). If multiple types are specified, returned entities will contain one or more of these types. location query repeated True type string path v1/{+parent}/publicKnowledgeGraphEntities:Search response $ref GoogleCloudEnterpriseknowledgegraphV1SearchPublicKgResponse scopes https://www.googleapis.com/auth/cloud-platform revision 20250131 rootUrl https://enterpriseknowledgegraph.googleapis.com/ schemas GoogleCloudEnterpriseknowledgegraphMainCommonOperationMetadata description The common metadata for long running operations. id GoogleCloudEnterpriseknowledgegraphMainCommonOperationMetadata properties createTime description The creation time of the operation. format google-datetime type string state description The state of the operation. enum STATE_UNSPECIFIED RUNNING CANCELLING SUCCEEDED FAILED CANCELLED PENDING enumDescriptions Unspecified state. Operation is still running. Operation is being cancelled. Operation succeeded. Operation failed. Operation is cancelled. Operation is pending not running yet. type string updateTime description The last update time of the operation. format google-datetime type string type object GoogleCloudEnterpriseknowledgegraphV1AffinityClusteringConfig description Options for affinity clustering. id GoogleCloudEnterpriseknowledgegraphV1AffinityClusteringConfig properties compressionRoundCount description Number of iterations to perform. Default value is 1. format int64 type string type object GoogleCloudEnterpriseknowledgegraphV1BigQueryInputConfig description The input config for BigQuery tables. id GoogleCloudEnterpriseknowledgegraphV1BigQueryInputConfig properties bigqueryTable description Required. Format is `projects/*/datasets/*/tables/*`. type string gcsUri description Required. Schema mapping file type string type object GoogleCloudEnterpriseknowledgegraphV1CancelEntityReconciliationJobRequest description Request message for CancelEntityReconciliationJob. id GoogleCloudEnterpriseknowledgegraphV1CancelEntityReconciliationJobRequest properties type object GoogleCloudEnterpriseknowledgegraphV1ConnectedComponentsConfig description Options for connected components. id GoogleCloudEnterpriseknowledgegraphV1ConnectedComponentsConfig properties weightThreshold description Threshold used for connected components. Default value is 0.85. format float type number type object GoogleCloudEnterpriseknowledgegraphV1DeleteOperationMetadata description Details of operations that perform deletes of any entities. id GoogleCloudEnterpriseknowledgegraphV1DeleteOperationMetadata properties commonMetadata $ref GoogleCloudEnterpriseknowledgegraphMainCommonOperationMetadata description The common part of the operation metadata. type object GoogleCloudEnterpriseknowledgegraphV1EntityReconciliationJob description Entity reconciliation job message. id GoogleCloudEnterpriseknowledgegraphV1EntityReconciliationJob properties createTime description Output only. Time when the EntityReconciliationJob was created. format google-datetime readOnly True type string endTime description Output only. Time when the EntityReconciliationJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. format google-datetime readOnly True type string error $ref GoogleRpcStatus description Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. readOnly True inputConfig $ref GoogleCloudEnterpriseknowledgegraphV1InputConfig description Required. Information about the input BigQuery tables. name description Output only. Resource name of the EntityReconciliationJob. readOnly True type string outputConfig $ref GoogleCloudEnterpriseknowledgegraphV1OutputConfig description Required. The desired output location. reconConfig $ref GoogleCloudEnterpriseknowledgegraphV1ReconConfig description Optional. Recon configs to adjust the clustering behavior. state description Output only. The detailed state of the job. enum JOB_STATE_UNSPECIFIED JOB_STATE_PENDING JOB_STATE_RUNNING JOB_STATE_SUCCEEDED JOB_STATE_FAILED JOB_STATE_CANCELLED JOB_STATE_KNOWLEDGE_EXTRACTION JOB_STATE_RECON_PREPROCESSING JOB_STATE_CLUSTERING JOB_STATE_EXPORTING_CLUSTERS enumDescriptions The job state is unspecified. The service is preparing to run the job. The job is in progress. The job completed successfully. The job failed. The job has been cancelled. Entity Recon API: The knowledge extraction job is running. Entity Recon API: The preprocessing job is running. Entity Recon API: The clustering job is running. Entity Recon API: The exporting clusters job is running. readOnly True type string updateTime description Output only. Time when the EntityReconciliationJob was most recently updated. format google-datetime readOnly True type string type object GoogleCloudEnterpriseknowledgegraphV1InputConfig description The desired input location and metadata. id GoogleCloudEnterpriseknowledgegraphV1InputConfig properties bigqueryInputConfigs description Set of input BigQuery tables. items $ref GoogleCloudEnterpriseknowledgegraphV1BigQueryInputConfig type array entityType description Entity type enum ENTITY_TYPE_UNSPECIFIED PEOPLE ESTABLISHMENT PROPERTY PRODUCT ORGANIZATION LOCAL_BUSINESS PERSON enumDeprecated False True True True False False False False enumDescriptions The default value. People entity. Establishment entity. Property entity. e.g. real estate property. Product entity. Organization entity. Local Business entity. Person entity. type string previousResultBigqueryTable description Optional. Provide the bigquery table containing the previous results if cluster ID stability is desired. Format is `projects/*/datasets/*/tables/*`. type string type object GoogleCloudEnterpriseknowledgegraphV1ListEntityReconciliationJobsResponse description Response message for EnterpriseKnowledgeGraphService.ListEntityReconciliationJobs. id GoogleCloudEnterpriseknowledgegraphV1ListEntityReconciliationJobsResponse properties entityReconciliationJobs description A list of EntityReconciliationJobs that matches the specified filter in the request. items $ref GoogleCloudEnterpriseknowledgegraphV1EntityReconciliationJob type array nextPageToken description The standard List next-page token. type string type object GoogleCloudEnterpriseknowledgegraphV1LookupPublicKgResponse description . . . Response message for EnterpriseKnowledgeGraphService.LookupPublicKg. id GoogleCloudEnterpriseknowledgegraphV1LookupPublicKgResponse properties @context description The local context applicable for the response. See more details at https://www.w3.org/TR/json-ld/#context-definitions. type any @type description The schema type of top-level JSON-LD object, e.g. ItemList. type any itemListElement description The item list of search results. items type any type array type object GoogleCloudEnterpriseknowledgegraphV1LookupResponse description . . . Response message for EnterpriseKnowledgeGraphService.Lookup. id GoogleCloudEnterpriseknowledgegraphV1LookupResponse properties @context description The local context applicable for the response. See more details at https://www.w3.org/TR/json-ld/#context-definitions. type any @type description The schema type of top-level JSON-LD object, e.g. ItemList. type any itemListElement description The item list of search results. items type any type array type object GoogleCloudEnterpriseknowledgegraphV1OutputConfig description The desired output location and metadata. id GoogleCloudEnterpriseknowledgegraphV1OutputConfig properties bigqueryDataset description Format is `projects/*/datasets/*`. type string type object GoogleCloudEnterpriseknowledgegraphV1ReconConfig description Recon configs id GoogleCloudEnterpriseknowledgegraphV1ReconConfig properties affinityClusteringConfig $ref GoogleCloudEnterpriseknowledgegraphV1AffinityClusteringConfig description Configs for affinity clustering. connectedComponentsConfig $ref GoogleCloudEnterpriseknowledgegraphV1ConnectedComponentsConfig description Configs for connected components. modelConfig $ref GoogleCloudEnterpriseknowledgegraphV1ReconConfigModelConfig description Model Configs options $ref GoogleCloudEnterpriseknowledgegraphV1ReconConfigOptions description Extra options that affect entity clustering behavior. type object GoogleCloudEnterpriseknowledgegraphV1ReconConfigModelConfig description Model Configs id GoogleCloudEnterpriseknowledgegraphV1ReconConfigModelConfig properties modelName description Model name. Refer to external documentation for valid names. If unspecified, it defaults to the one mentioned in the documentation. type string versionTag description Model version tag. Refer to external documentation for valid tags. If unspecified, it defaults to the one mentioned in the documentation. type string type object GoogleCloudEnterpriseknowledgegraphV1ReconConfigOptions description Options for experimental changes on entity clustering behavior. id GoogleCloudEnterpriseknowledgegraphV1ReconConfigOptions properties enableGeocodingSeparation description If true, separate clusters by their geographic region (from geocoding). Uses the following entity features: - schema.org/addressLocality - schema.org/addressRegion - schema.org/addressCountry Warning: processing will no longer be regionalized! type boolean type object GoogleCloudEnterpriseknowledgegraphV1SearchPublicKgResponse description . . . Response message for EnterpriseKnowledgeGraphService.Search. id GoogleCloudEnterpriseknowledgegraphV1SearchPublicKgResponse properties @context description The local context applicable for the response. See more details at https://www.w3.org/TR/json-ld/#context-definitions. type any @type description The schema type of top-level JSON-LD object, e.g. ItemList. type any itemListElement description The item list of search results. items type any type array type object GoogleCloudEnterpriseknowledgegraphV1SearchResponse description . . . Response message for EnterpriseKnowledgeGraphService.Search. id GoogleCloudEnterpriseknowledgegraphV1SearchResponse properties @context description The local context applicable for the response. See more details at https://www.w3.org/TR/json-ld/#context-definitions. type any @type description The schema type of top-level JSON-LD object, e.g. ItemList. type any itemListElement description The item list of search results. items type any type array type object GoogleProtobufEmpty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id GoogleProtobufEmpty properties type object GoogleRpcStatus description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id GoogleRpcStatus properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object servicePath title Enterprise Knowledge Graph API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/europe-central2-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-central2-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-central2-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-central2-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-central2-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-central2-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-central2-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-north1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-north1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-north1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-north1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-north1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-north1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-north1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-southwest1-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west1-artifactregistry-v1beta2	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/europe-west1-assuredworkloads-	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/europe-west1-assuredworkloads-v1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/europe-west1-assuredworkloads-v1beta1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/europe-west1-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west1-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west1-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west1-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west1-connectgateway-	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/europe-west1-connectgateway-v1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/europe-west1-connectgateway-v1beta1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/europe-west1-containerfilesystem-v1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/cloud-platform.read-only description View your data across Google Cloud services and see the email address of your Google Account https://www.googleapis.com/auth/devstorage.full_control description Manage your data and permissions in Cloud Storage and see the email address for your Google Account https://www.googleapis.com/auth/devstorage.read_only description View your data in Google Cloud Storage https://www.googleapis.com/auth/devstorage.read_write description Manage your data in Cloud Storage and see the email address of your Google Account basePath baseUrl https://containerfilesystem.googleapis.com/ batchPath batch canonicalName Container File System description Stream images stored in Artifact Registry to GKE discoveryVersion v1 documentationLink https://cloud.google.com/kubernetes-engine/docs/how-to/image-streaming fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id containerfilesystem:v1 kind discovery#restDescription mtlsRootUrl https://containerfilesystem.mtls.googleapis.com/ name containerfilesystem ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects methods auth description Authenticate the request for a given image name. Returns image id and access token. flatPath v1/projects/{projectsId}:auth httpMethod POST id containerfilesystem.projects.auth parameterOrder imageProject parameters imageProject description ID of the project hosting the image in the form of 'projects/my-project'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide (Cloud Riptide). location path pattern ^projects/[^/]+$ required True type string path v1/{+imageProject}:auth request $ref AuthImageRequest response $ref AuthImageReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write resources files methods readContent description Get file contents spanning a requested offset and length within a file. flatPath v1/projects/{projectsId}/files/{filesId} httpMethod GET id containerfilesystem.projects.files.readContent parameterOrder imageProject contentHash parameters accessToken description Access token used to verify access. Not used in GAE Riptide. location query type string contentHash description The SHA256 hexdigest of the file contents (uniquely identifies the file). location path pattern ^[^/]+$ required True type string decryptedContentHash description The SHA256 hexdigest of the decrypted file contents. If set, this means the content_hash field is the encrypted content hash. If the decrypted content is in fileserver caches, it will be returned instead of the encrypted content specified by the content_hash field. The client can determine which version was returned by inspecting the content_hash field of the reply. location query type string filePath description File path is optional unless auth is enabled. File path is used to optimize lookups if a given file is in the authorized layer from access token. location query type string fileSize description File size is optional, and is a hint to the file server, which can use the hint to speculate whether the file is a single-block file. format int64 location query type string imageId description Optional image ID where the file resides. Used only for prefetch list recording on fileserver-proxy for OnePlatform (GKE FUSE) clients. location query type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string length description The length to read. format int64 location query type string offset description The offset into the file from which to read. format int64 location query type string readSessionId description The id of the session (read-ahead/prefetch) that the current request belongs to. It takes the following forms: - "original_req_offset:original_req_length:read_ahead_size" for read ahead. location query type string retryAttempt description Retry attempt number. format int32 location query type integer type description Read type. Can be used by the backend for request handling and logging. enum DEFAULT READ_AHEAD PREFETCH enumDescriptions A regular content read. A read-ahead read (aka cache warming). A prefetching read. location query type string path v1/{+imageProject}/files/{+contentHash} response $ref ReadContentReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write layers methods get description Get the filesystem metadata for an individual layer of an image. flatPath v1/projects/{projectsId}/layers/{layersId} httpMethod GET id containerfilesystem.projects.layers.get parameterOrder imageProject layerId parameters accessToken description Access token used to verify access. Not used in GAE Riptide. location query type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string layerId description The layer ID, e.g. "sha256:abc...def" location path pattern ^[^/]+$ required True type string retryAttempt description Retry attempt number. format int32 location query type integer path v1/{+imageProject}/layers/{+layerId} response $ref LayerReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write prefetch methods get description Get the prefetch list bucket content of a specific image. flatPath v1/projects/{projectsId}/prefetch/{prefetchId} httpMethod GET id containerfilesystem.projects.prefetch.get parameterOrder imageProject filesystemId parameters accessToken description Serialized riptide.PrefetchAccessToken (from AuthImageReply.prefetch_token), encrypted with the server key and base64 encoded. This field is optional and set only if the API authentication is enabled. optional location query type string contextKey description Context key used to distinguish runs of the same image but with different parameters or arguments. location query type string filesystemId description The filesystem identifier, as defined in [MakeFileSystemID](http://google3/apphosting/sandbox/titanium/multi_container.cc?l=425&rcl=327218176). location path pattern ^[^/]+$ required True type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string path v1/{+imageProject}/prefetch/{+filesystemId} response $ref PrefetchImageReportReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write revision 20250125 rootUrl https://containerfilesystem.googleapis.com/ schemas APIBackoffConfig id APIBackoffConfig properties initialInterval description Initial duration for an RPC call retry policy. format google-duration type string maxDuration description Maximum duration for an RPC call retry policy. format google-duration type string maxRetries description Maximum number of retries for an RPC call. format uint64 type string multiplier description Exponential backoff multiplier for an RPC call retry policy. format double type number randomizationFactor description Randomization factor for an RPC call retry policy. format double type number type object AuthImageReply id AuthImageReply properties config $ref Config description The image config (env, port, cmd, ...) retrieved from Riptide Spanner. This will be useful for OnePlatform FUSE to populate the image config blob content as a FUSE file entry, so that `ctr run --rootfs ... --env ...` cmd can be easily executed, without having to perform a GET config blob req. imageId description Riptide image id (digest of the config file for docker schema 2) type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide (Cloud Riptide). Any subsequent RPC calls (GetLayer, ReadContent, GetPrefetchImageReport) should copy this value over to their corresponding request's image_project field. type string layers description A list of layers sorted by position, i.e. the first layer is the top-most layer of the image. The Layer proto also includes the encrypted LayerAccessToken which is required to access the respective layer and files within the layer. items $ref Layer type array prefetchToken description Encrypted and Base64 encoded prefetch token (PrefetchAccessToken protobuf message, serialized and encrypted with the server's key, which is not known to the client) type string serverParameters $ref ServerParameters description These parameters override the default const values or the values provided via command line flags. Parameter's 'scope' defines how it is pushed and how it is applied. The parameter scopes are defined as follows: - 'client' - applies to all features and RPCs of a particular client instance. These parameters are only honored when pushed in the reply of the initial AuthImage probe call. - 'image' - applies to features and RPC issued by particular client instance on the per-image basis.These parameters can be pushed in any AuthImage RPC reply. tokenExpirationTimeMs description Timestamp when the access token expires. format int64 type string type object AuthImageRequest id AuthImageRequest properties clientPlatform $ref ClientPlatform description Architecture and OS AuthImage uses to get the manifest from the manifest list. This is for multiplatform support. imageName description Full image name e.g. gcr.io/my-project/repo/image:tag or gcr.io/my-project/repo/image@digest type string pullSecret description Registry login credential ("(oauth2accesstoken|_json_key(_base64)?):.*") to support GKE imagePullSecrets (http://shortn/_V9ztR0xHVE). Allowed/ supported usernames/passwords are based on http://shortn/_9XF9GH1QIl. Uses RPC EUC if this field is empty. type string retryAttempt description Retry attempt number. format int32 type integer status description Status that indicates the current stage of image caching on GCFSD side. See go/riptide-authimage-heartbeat for more details. enum DEFAULT INITIAL REFRESH CACHED CACHE_DISABLED PROBE enumDescriptions Default value received from old clients that do not distinguish between different AuthImage types. First AuthImageRequest sent for image. Auth refresh heartbeat before image is fully cached. Image has been fully cached by client. The client has cache disabled. Initial server probing. type string type object ClientConfig id ClientConfig properties authImageBackoff $ref APIBackoffConfig description Backoff policy parameters for the AuthImage RPC. The max_duration field is ignored since AuthImage uses a constant backoff policy. policy. enableSingleFlighting description If set, enables/disables the single flighting for an image. type boolean getLayerBackoff $ref APIBackoffConfig description Backoff policy parameters for the GetLayer RPC. readAheadMaxBlocks description If set, enables/disables the read-ahead feature. format int64 type string readContentBackoff $ref APIBackoffConfig description Backoff policy parameters for the ReadContent RPC. type object ClientPlatform id ClientPlatform properties architecture description The architecture used to get the manifest from the manifest list. type string os description The OS used to get the manifest from the manifest list. type string type object Cmd description Defines the command that should be run in the container id Cmd properties args description The arguments to supply the executable items type string type array exec description The executable name (may be resolved with $PATH from Env) required type string type object Config description Configuration for a single container, extracted from the image manifest. This is going to be built with non_prod compatibility, so we should avoid putting any trade secrets in this proto. NEXT TAG: 13 id Config properties architecture description The architecture that the image is built for type string cmd $ref Cmd description The resolved command that should be run command description The CMD of a container. See https://docs.docker.com/engine/reference/builder/#cmd items type string type array dir description The working directory type string entrypoint description The ENTRYPOINT of a container. See https://docs.docker.com/engine/reference/builder/#entrypoint items type string type array env description The environment variables and values to set items $ref Env type array foundVarLog description The image has /var/log directory or not. If yes, the overlay (go/gvisor-overlay) can be configured to /var/log when Logging Fs is mounted at this dir. The overlay will auto-mount any subdirectories recursively under /var/log. type boolean image description The image ID type string labels description A set of labels recorded on the container. This is just raw data coming from the OCI container metadata. items $ref Label type array os description The OS that the image is built for type string port description The network ports to expose items $ref Port type array user description The user[:group] for the command (i.e. the Dockerfile USER, verbatim) type string type object Directory description A (complete) directory in a filesystem layer. id Directory properties entries description Files in this directory. items $ref Entry type array opaque description True if the directory should not be merged with lower layers. type boolean path description The full path to the directory, excluding the leading "/". For example, "/" is the empty string, and "/usr" is represented as "usr". type string type object Entry description A single directory entry in a filesystem layer. id Entry properties name description The name of the directory entry, relative to the directory path. type string stat $ref FileStat description The filesystem metadata for the directory entry. type object Env description Defines an environment variable id Env properties name description Environment variable name, e.g. "PATH" required type string value description Environment variable value, e.g. "/usr/bin:/usr/sbin" type string type object ExtendedAttribute description File extended attributes entry. id ExtendedAttribute properties name type string value format byte type string type object FileBlock description A block of a file in the Riptide filesystem. id FileBlock properties blockData description The block contents. format byte type string blockHash description The SHA256 hexdigest of the block contents. type string lastBlock description Whether the block is the last block in the file. type boolean lowerBound description The lower bound (offset) of the block within the file. Inclusive. format int64 type string upperBound description The upper bound (offset+limit) of the block within the file. Exclusive: the block_data contains the range [lower_bound, upper_bound). format int64 type string type object FileStat description Riptide filesystem metadata for a file. LINT.IfChange id FileStat properties contentHash description SHA256 hexdigest of file contents. type string extendedAttributes description File extended attributes. More info at go/riptide-linux-xattr-support. This may not be populated for the images that do not have xattr support yet. TODO (b/204105260): Change the comment once all the images in Spanner are re-imported with xattr support. items $ref ExtendedAttribute type array gid description GID of file owner. format int32 type integer inlined description Whether the file came from an InlineLayer overlay. type boolean link description Link target (for hard and soft links). type string mode description Linux mode and permission bits. format uint32 type integer mtime description File modification timestamp (microseconds since Unix epoch). format int64 type string size description File size in bytes. format int64 type string uid description UID of file owner. format int32 type integer whiteout description Whether the file is a whiteout. type boolean type object ImageConfig id ImageConfig properties enablePrefetching description If set, enables/disables prefetching for an image. type boolean type object Label description Label is a simple key-value pair. id Label properties key type string value type string type object Layer description Describes a Docker image layer. id Layer properties bytesImported description compared with `layer_info.raw_bytes` to see progress, and can be used in combination with `import_start_time_usec` and the current timestamp to estimate the speed of the layer import. format int64 type string decryptedId description The decrypted layer ID. Populated only if `project_encryption_key_id` is non-empty. type string diffId description The Docker Diff ID (SHA256 digest of the layer tar). V2 schema only. type string digest description The SHA256 digest of the gzip'd layer tar. type string id description The layer ID. If from a v1 schema, this is the digest of the gzip contents. If from a v2 schema, this is the Docker Diff ID. For layers encrypted with a CMEK key, this ID is also encrypted, and `decrypted_id` contains the original layer ID. required type string importFinishTimeUsec description Unix timestamp (in micros) when the layer import completed, or 0 if the import has not completed. format int64 type string importStartTimeUsec description Unix timestamp (in micros) when the layer import started. format int64 type string lastActiveTimeUsec description The last active timestamp of the layer download from Layers.Task if the Layers.Status is not READY, and taken from ProjectLayers.Task otherwise. This determines if we need to restart the download or verification of a layer. format int64 type string layerAccessToken description Encrypted and Base64 encoded Riptide layer access token (LayerAccessToken protobuf message, serialized and encrypted with the server's key, which is not known to the client) type string layerInfo $ref LayerInfo description Various metatadata characterizing the size and contents, and other aspects of the layer. layerStatus description The status taken directly from Layers.Status. This may be READY even if `status` is not. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string mediaType description Layer media type. Empty for image manifest schema 1. type string projectEncryptionKeyId description Project encryption key ID for CMEK. If empty, the layer is not encrypted with a customer managed encryption key. type string projectLayerStatus description The status taken from ProjectLayers.Status. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string provenance description The layer provenance - where this layer came from (if known). enum PROVENANCE_UNKNOWN PROVENANCE_USER PROVENANCE_GOOGLE enumDescriptions Layer provenance is not known. Layer contains user code. Layer was provided by Google, e.g. in a base image. type string status description The status of the layer import (from Layers, or from ProjectLayers if the Layers.Status is READY). If this is READY, the layer is ready for use in the project. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string type object LayerInfo description Various metatadata characterizing the size and contents, and other aspects of a filesystem layer. id LayerInfo properties aiMlMarkers description Markers in the layer that categorize it as an AI/ML layer. items enum UNSPECIFIED CUDA TENSORFLOW enumDescriptions The layer contains CUDA libraries. The layer contains Tensorflow libraries. type string type array directories description The number of directories (both empty and non-empty) in the layer. format uint32 type integer entries description The number of entries in the layer's tar archive. Includes all directories, files, and whiteouts. format uint32 type integer fileBytes description The total number of bytes in all regular files in the layer. format int64 type string filePathSignature description A signature computed by XOR-ing the fingerprint2011 hashes of the file paths of regular files in the layer. format uint64 type string files description The number of regular files (empty and non-empty) in the layer. format uint32 type integer hardLinks description The number of hard links in the layer. format uint32 type integer rawBytes description The number of bytes in the raw (likely gzip compressed) layer blob that was downloaded from the registry at layer import time. format int64 type string softLinks description The number of soft links in the layer. format uint32 type integer tarBytes description The number of bytes in the layer's uncompressed tar archive. format int64 type string whiteouts description The number of whiteouts in the layer. The .wh..wh..opq file (which marks a directory as opaque) is counted as a whiteout (along with any whiteout files with paths like /path/to/.wh.). format uint32 type integer type object LayerReply description RPC response to the request for a Riptide layer. id LayerReply properties directories description The complete list of directories in this layer. items $ref Directory type array projectKeyId description The project key (DEK) identifier, if the layer is encrypted with CMEK. type string type object Port description Defines a TCP or UDP port by protocol and number id Port properties containerPort description The port number within the container's net namespace (0-65535) required format int32 type integer hostPort description The port number outside of the net namespace (if any) (0-65535) format int32 type integer protocol description The protocol (TCP or UDP) required enum PROTO_NONE PROTO_TCP PROTO_UDP enumDescriptions Unknown TCP UDP type string type object PrefetchFileReport description PrefetchFileReport contains one or more reads within the same file. Each read is associated to a file using its file identifier. This allow the server to be able to authorize the client access to the file. id PrefetchFileReport properties fileId description Field used to uniquely identify a file. If the layer_access_token for the layer is set it means that the authentication is enabled; if so the file_id will be the riptide.FileIdentifier encrypted with the layer_encryption key and base64-encoded (more details at go/riptide-auth-design). If the authentication is not enabled this instead will be the file content_hash. type string filePosition description Position within the merged prefetch list of reads executed by the application. format int32 type integer fileSize description File size, as reported by the prefetch recorder based on the SandboxFS. format int64 type string offsets description List of offsets read within the file. Note that reads are aligned at 1MB block sizes. If the list of offsets is empty indicates that the read covers the whole file. items format int64 type string type array type object PrefetchImageReport description LINT.IfChange id PrefetchImageReport properties contextKey description Context key used to distinguish runs of the same image but with different parameters or arguments. type string creationTimestampMicros description Timestamp creation of this report. format int64 type string filesystemId description The filesystem identifier, as defined in [MakeFileSystemID](http://google3/apphosting/sandbox/titanium/multi_container.cc?l=425&rcl=327218176). type string generation description Initially set to 0 indicates that the report is partial. Values greater than 0 indicates a complete report. For more details about how the value changes as a result of a merge process, please refer to the merge logic at http://google3/cloud/containers/riptide/prefetch/prefetch_list_merge.cc. format int64 type string layers description The list of block reads within a layer issued by the container. items $ref PrefetchLayerReport type array version description This field allows to distinguish between different versions of the prefetch list code. This enables the possibility to change the logic and eventually take actions on old reports generated by the previous logic. Set this value to the cl number that changes the logic. The current value is defined in the Recorder library http://google3/cloud/containers/riptide/prefetch/recorder.cc. format int64 type string type object PrefetchImageReportReply description RPC reply for the GetPrefetchImageReport. id PrefetchImageReportReply properties imageReport $ref PrefetchImageReport description The image report requested. type object PrefetchLayerReport id PrefetchLayerReport properties files description List of file reads issued by the client within this layer. items $ref PrefetchFileReport type array layerId description The layer id. type string type object ReadContentReply description RPC response to the request to read from a file in Riptide. id ReadContentReply properties blocks description File blocks that cover the requested offset and length. items $ref FileBlock type array contentHash description The SHA256 hexdigest of the returned file. This can be used to distinguish whether the fileserver was able to return the decrypted version of the requested encrypted content. type string type object ServerParameters id ServerParameters properties clientConfig $ref ClientConfig description ClientConfig is the configuration for all RPCs/features of a particular client instance. It should be set only once and then it stays immutable. imageConfig $ref ImageConfig description ImageConfig is the configuration for customizing features/RPC behavior on per image basis. type object servicePath title Container File System API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/europe-west1-d-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west1-d-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west1-d-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west1-d-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west1-d-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west1-d-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west1-d-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west1-datalineage-	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/europe-west1-datalineage-v1	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/europe-west1-gkemulticloud-	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/europe-west1-gkemulticloud-v1	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/europe-west1-iamcredentials-	values_changed root['revision'] new_value 20250130 old_value 20250122
prod/europe-west1-iamcredentials-v1	values_changed root['revision'] new_value 20250130 old_value 20250122
prod/europe-west1-logging-v2	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/europe-west1-logging-v2beta1	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/europe-west1-monitoring-	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/europe-west1-monitoring-v1	dictionary_item_removed root['schemas']['PieChartDataSet']['properties']['breakdowns'] values_changed root['revision'] new_value 20250127 old_value 20250120
prod/europe-west1-monitoring-v3	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/europe-west1-workflowexecutions-	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/europe-west1-workflowexecutions-v1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/europe-west1-workflowexecutions-v1alpha1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/europe-west1-workflowexecutions-v1beta	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/europe-west10-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west10-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west12-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-artifactregistry-	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/europe-west2-artifactregistry-v1beta2	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/europe-west2-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-cloudbuild-	values_changed root['resources']['projects']['resources']['locations']['resources']['connections']['methods']['processWebhook']['parameters']['webhookKey']['description'] new_value Arbitrary additional key to find the matching repository for a webhook event if needed. old_value Arbitrary additional key to find the maching repository for a webhook event if needed. root['revision'] new_value 20250129 old_value 20250117
prod/europe-west2-cloudbuild-v1	values_changed root['revision'] new_value 20250129 old_value 20250117
prod/europe-west2-cloudbuild-v2	values_changed root['resources']['projects']['resources']['locations']['resources']['connections']['methods']['processWebhook']['parameters']['webhookKey']['description'] new_value Arbitrary additional key to find the matching repository for a webhook event if needed. old_value Arbitrary additional key to find the maching repository for a webhook event if needed. root['revision'] new_value 20250129 old_value 20250117
prod/europe-west2-cloudkms-v1	values_changed root['revision'] new_value 20250203 old_value 20250124
prod/europe-west2-connectgateway-	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/europe-west2-connectgateway-v1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/europe-west2-connectgateway-v1beta1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/europe-west2-datacatalog-	values_changed root['revision'] new_value 20250131 old_value 20250122
prod/europe-west2-datacatalog-v1	values_changed root['revision'] new_value 20250131 old_value 20250122
prod/europe-west2-gkemulticloud-	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/europe-west2-gkemulticloud-v1	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/europe-west2-monitoring-	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/europe-west2-monitoring-v1	dictionary_item_removed root['schemas']['PieChartDataSet']['properties']['breakdowns'] values_changed root['revision'] new_value 20250127 old_value 20250120
prod/europe-west2-monitoring-v3	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/europe-west2-pubsub-	values_changed root['revision'] new_value 20250128 old_value 20250123
prod/europe-west2-pubsub-v1	dictionary_item_added root['schemas']['JavaScriptUDF'] root['schemas']['MessageTransform'] root['schemas']['Subscription']['properties']['messageTransforms'] root['schemas']['Topic']['properties']['messageTransforms'] values_changed root['revision'] new_value 20250128 old_value 20250123
prod/europe-west2-pubsub-v1beta2	values_changed root['revision'] new_value 20250128 old_value 20250123
prod/europe-west2-speech-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-speech-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-speech-v1p1beta1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-speech-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west2-workflowexecutions-	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/europe-west2-workflowexecutions-v1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/europe-west2-workflowexecutions-v1alpha1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/europe-west2-workflowexecutions-v1beta	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/europe-west3-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west3-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west3-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west3-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west3-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west3-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west3-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west3-aiplatform-	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['featureGroups']['resources']['featureMonitors']['methods']['patch'] root['schemas']['GoogleCloudAiplatformV1beta1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1RolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1DeployedModel']['properties']['rolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1beta1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1beta1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1beta1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/europe-west3-aiplatform-v1	dictionary_item_added root['schemas']['GoogleCloudAiplatformV1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/europe-west3-aiplatform-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/europe-west3-aiplatform-v1beta1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['featureGroups']['resources']['featureMonitors']['methods']['patch'] root['schemas']['GoogleCloudAiplatformV1beta1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1RolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1DeployedModel']['properties']['rolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1beta1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1beta1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1beta1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/europe-west3-artifactregistry-	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/europe-west3-artifactregistry-v1beta1	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/europe-west3-artifactregistry-v1beta2	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/europe-west3-cloudkms-	values_changed root['revision'] new_value 20250203 old_value 20250124
prod/europe-west3-cloudkms-v1	values_changed root['revision'] new_value 20250203 old_value 20250124
prod/europe-west3-dialogflow-	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/europe-west3-dialogflow-v1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/europe-west3-dialogflow-v2	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/europe-west3-dialogflow-v2beta1	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/europe-west3-dialogflow-v3	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/europe-west3-dialogflow-v3alpha1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/europe-west3-dialogflow-v3beta1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/europe-west3-gkemulticloud-	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/europe-west3-gkemulticloud-v1	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/europe-west3-logging-v1	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/europe-west3-logging-v2	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/europe-west3-run-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/europe-west3-run-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/europe-west3-run-v2	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/europe-west4-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west4-ml-	values_changed root['revision'] new_value 20250201 old_value 20250118
prod/europe-west4-ml-v1	values_changed root['revision'] new_value 20250201 old_value 20250118
prod/europe-west6-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west6-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west8-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west9-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west9-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west9-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west9-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west9-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west9-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/europe-west9-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/eventarc-v1	values_changed root['revision'] new_value 20250131 old_value 20250124
prod/fcm-	values_changed root['revision'] new_value 20250204 old_value 20250124
prod/fcm-v1	values_changed root['revision'] new_value 20250204 old_value 20250124
prod/fcmdata-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/fcmdata-v1beta1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/fcmregistrations-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/fcmregistrations-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/file-	values_changed root['revision'] new_value 20250129 old_value 20250127
prod/firebase-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebase-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebase-v1alpha	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebase-v1beta1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebaseappdistribution-	values_changed root['revision'] new_value 20250206 old_value 20250204 iterable_item_added root['schemas']['GoogleFirebaseAppdistroV1alphaGetUploadStatusResponse']['properties']['errorCode']['enum'][22] APP_NOT_FOUND root['schemas']['GoogleFirebaseAppdistroV1alphaGetUploadStatusResponse']['properties']['errorCode']['enumDescriptions'][22] Happens if the Firebase app no longer exists by the time of extraction
prod/firebaseappdistribution-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/firebaseappdistribution-v1alpha	values_changed root['revision'] new_value 20250206 old_value 20250204 iterable_item_added root['schemas']['GoogleFirebaseAppdistroV1alphaGetUploadStatusResponse']['properties']['errorCode']['enum'][22] APP_NOT_FOUND root['schemas']['GoogleFirebaseAppdistroV1alphaGetUploadStatusResponse']['properties']['errorCode']['enumDescriptions'][22] Happens if the Firebase app no longer exists by the time of extraction
prod/firebaseapphosting-	values_changed root['revision'] new_value 20250127 old_value 20250124
prod/firebaseapphosting-v1alpha	values_changed root['revision'] new_value 20250127 old_value 20250124
prod/firebaseapphosting-v1beta	values_changed root['revision'] new_value 20250127 old_value 20250124
prod/firebaseapptesters-	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://firebaseapptesters.googleapis.com/ batchPath batch canonicalName Firebaseapptesters description discoveryVersion v1 documentationLink https://firebase.google.com/products/app-distribution fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id firebaseapptesters:v1alpha kind discovery#restDescription mtlsRootUrl https://firebaseapptesters.mtls.googleapis.com/ name firebaseapptesters ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources devices methods create description Creates a device flatPath v1alpha/devices httpMethod POST id firebaseapptesters.devices.create parameterOrder parameters path v1alpha/devices request $ref GoogleFirebaseApptestersV1alphaDevice response $ref GoogleFirebaseApptestersV1alphaDevice scopes https://www.googleapis.com/auth/cloud-platform get description Get a single device flatPath v1alpha/devices/{devicesId} httpMethod GET id firebaseapptesters.devices.get parameterOrder name parameters name description Required. The name of the device to retrieve Format: devices/{device} location path pattern ^devices/[^/]+$ required True type string path v1alpha/{+name} response $ref GoogleFirebaseApptestersV1alphaDevice scopes https://www.googleapis.com/auth/cloud-platform list description Get a list of devices for a tester A device represents a physical device that is used by a tester to test an app. Testers can use multiple devices to test apps. For each device a tester uses, the tester must consent to sharing the device's data for an app in order to view that app's releases. This is required for iOS apps. Specifically, for iOS apps with Ad-hoc distributions, we need to access the devices UUID to determine if the release can be downloaded on the tester's device. Devices are parents of apps because the device that a tester is using affects the values of fields in the App and Release messages. flatPath v1alpha/devices httpMethod GET id firebaseapptesters.devices.list parameterOrder parameters pageSize description Maximum number of devices to return format int32 location query type integer pageToken description Page token received from previous ListDevices call location query type string path v1alpha/devices response $ref GoogleFirebaseApptestersV1alphaListDevicesResponse scopes https://www.googleapis.com/auth/cloud-platform resources testerApps methods consent description Consent to share the device's data for an app Testers are required to consent to having the device's data shared for the app in order to view the app's releases. flatPath v1alpha/devices/{devicesId}/testerApps/{testerAppsId}:consent httpMethod POST id firebaseapptesters.devices.testerApps.consent parameterOrder name parameters name description Required. The name of the app Format: devices/{device}/testerApps/{tester_app} location path pattern ^devices/[^/]+/testerApps/[^/]+$ required True type string path v1alpha/{+name}:consent request $ref GoogleFirebaseApptestersV1alphaConsentAppRequest response $ref GoogleFirebaseApptestersV1alphaConsentAppResponse scopes https://www.googleapis.com/auth/cloud-platform delete description Leave a particular app that a tester has access to flatPath v1alpha/devices/{devicesId}/testerApps/{testerAppsId} httpMethod DELETE id firebaseapptesters.devices.testerApps.delete parameterOrder name parameters name description Required. The name of the app Format: devices/{device}/testerApps/{tester_app} location path pattern ^devices/[^/]+/testerApps/[^/]+$ required True type string path v1alpha/{+name} response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform get description Get a single app for a device flatPath v1alpha/devices/{devicesId}/testerApps/{testerAppsId} httpMethod GET id firebaseapptesters.devices.testerApps.get parameterOrder name parameters name description Required. The name of the tester app to retrieve Format: devices/{device}/testerApps/{tester_app} location path pattern ^devices/[^/]+/testerApps/[^/]+$ required True type string path v1alpha/{+name} response $ref GoogleFirebaseApptestersV1alphaTesterApp scopes https://www.googleapis.com/auth/cloud-platform list description Get a list of apps for a device flatPath v1alpha/devices/{devicesId}/testerApps httpMethod GET id firebaseapptesters.devices.testerApps.list parameterOrder parent parameters includePending description Optional. Whether or not to include apps pending invitation in the result location query type boolean pageSize description Maximum number of apps to return format int32 location query type integer pageToken description Page token received from previous ListTesterApps calld location query type string parent description Required. The parent, which owns the app Format: devices/{device} location path pattern ^devices/[^/]+$ required True type string path v1alpha/{+parent}/testerApps response $ref GoogleFirebaseApptestersV1alphaListTesterAppsResponse scopes https://www.googleapis.com/auth/cloud-platform resources installations resources releases methods list description List releases for an app by firebase installation id (FID) flatPath v1alpha/devices/{devicesId}/testerApps/{testerAppsId}/installations/{installationsId}/releases httpMethod GET id firebaseapptesters.devices.testerApps.installations.releases.list parameterOrder parent parameters pageSize description Maximum number of releases to return format int32 location query type integer pageToken description Page token received from previous ListDevices call location query type string parent description Required. The parent, which owns the collection of installation releases Format: projects/{project}/installations/{installation} deprecated Format: devices/{device}/testerApps/{tester_app}/installations/{installation} location path pattern ^devices/[^/]+/testerApps/[^/]+/installations/[^/]+$ required True type string path v1alpha/{+parent}/releases response $ref GoogleFirebaseApptestersV1alphaListTesterAppInstallationReleasesResponse scopes https://www.googleapis.com/auth/cloud-platform releases methods download description Download a release This endpoint is authenticated with the token query param. To make a request to this endpoint, use the URL returned by ListReleases, in the download_url field on each Release, which contains an expiring token that validates calls using that URL only. flatPath v1alpha/devices/{devicesId}/testerApps/{testerAppsId}/releases/{releasesId}:download httpMethod GET id firebaseapptesters.devices.testerApps.releases.download parameterOrder name parameters name description Required. The name of the release to download Format: devices/{device}/testerApps/{tester_app}/releases/{release} location path pattern ^devices/[^/]+/testerApps/[^/]+/releases/[^/]+$ required True type string testerClient description The tester client which this download request is coming from enum TESTER_CLIENT_UNSPECIFIED ANDROID_TESTER_APP WEB IOS_SDK ANDROID_SDK enumDescriptions Tester client unspecified App Tester native android app Web-based tester client (Android & iOS) iOS SDK (new build alerts) Android SDK (new build alerts) location query type string token description Required. A temporary signed token verifying the URL This is set in DownloadUrlCreator and validated in DownloadReleaseAction using RequestUrlVerifier location query type string path v1alpha/{+name}:download response $ref GoogleApiHttpBody scopes https://www.googleapis.com/auth/cloud-platform get description Get a single release for the app flatPath v1alpha/devices/{devicesId}/testerApps/{testerAppsId}/releases/{releasesId} httpMethod GET id firebaseapptesters.devices.testerApps.releases.get parameterOrder name parameters name description Required. The name of the release to retrieve Format: devices/{device}/testerApps/{tester_app}/releases/{release} location path pattern ^devices/[^/]+/testerApps/[^/]+/releases/[^/]+$ required True type string testerClient description The tester client which this download request is coming from enum TESTER_CLIENT_UNSPECIFIED ANDROID_TESTER_APP WEB IOS_SDK ANDROID_SDK enumDescriptions Tester client unspecified App Tester native android app Web-based tester client (Android & iOS) iOS SDK (new build alerts) Android SDK (new build alerts) location query type string path v1alpha/{+name} response $ref GoogleFirebaseApptestersV1alphaRelease scopes https://www.googleapis.com/auth/cloud-platform list description List releases for the app flatPath v1alpha/devices/{devicesId}/testerApps/{testerAppsId}/releases httpMethod GET id firebaseapptesters.devices.testerApps.releases.list parameterOrder parent parameters filter description Filter for the list of releases. Used in search. location query type string pageSize description Maximum number of releases to return format int32 location query type integer pageToken description Page token received from previous `ListReleases` call location query type string parent description Required. The parent, which owns the collection of releases Format: devices/{device}/testerApps/{tester_app} location path pattern ^devices/[^/]+/testerApps/[^/]+$ required True type string testerClient description The tester client which this download request is coming from enum TESTER_CLIENT_UNSPECIFIED ANDROID_TESTER_APP WEB IOS_SDK ANDROID_SDK enumDescriptions Tester client unspecified App Tester native android app Web-based tester client (Android & iOS) iOS SDK (new build alerts) Android SDK (new build alerts) location query type string path v1alpha/{+parent}/releases response $ref GoogleFirebaseApptestersV1alphaListReleasesResponse scopes https://www.googleapis.com/auth/cloud-platform invitations methods get description Get invitation for tester. Invitations are created by Developers or by testers via invite links. Invitations link an email address to an app. flatPath v1alpha/invitations/{invitationsId} httpMethod GET id firebaseapptesters.invitations.get parameterOrder name parameters name description Required. The name of the app to retrieve Format: invitations/{invitation} location path pattern ^invitations/[^/]+$ required True type string path v1alpha/{+name} response $ref GoogleFirebaseApptestersV1alphaInvitation scopes https://www.googleapis.com/auth/cloud-platform subscribe description Subscribe to invitation Testers use this method to update the subscription status for the email address that is associated with the invitation. flatPath v1alpha/invitations/{invitationsId}:subscribe httpMethod POST id firebaseapptesters.invitations.subscribe parameterOrder name parameters name description Required. The name of the invitation Format: invitations/{invitation} location path pattern ^invitations/[^/]+$ required True type string path v1alpha/{+name}:subscribe request $ref GoogleFirebaseApptestersV1alphaSubscribeInvitationRequest response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform unsubscribe description Unsubscribe from invitation Testers use this method to update the unsubscription status for the email address that is associated with the invitation. flatPath v1alpha/invitations/{invitationsId}:unsubscribe httpMethod POST id firebaseapptesters.invitations.unsubscribe parameterOrder name parameters name description Required. The name of the invitation Format: invitations/{invitation} location path pattern ^invitations/[^/]+$ required True type string path v1alpha/{+name}:unsubscribe request $ref GoogleFirebaseApptestersV1alphaUnsubscribeInvitationRequest response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform inviteLinks methods accept description Accepts an invite link for an app When a tester accepts an invite link, an invitation is created and an email is sent flatPath v1alpha/inviteLinks/{inviteLinksId}:accept httpMethod POST id firebaseapptesters.inviteLinks.accept parameterOrder name parameters name description Required. The name of the invite link Format: inviteLinks/{invite_link} location path pattern ^inviteLinks/[^/]+$ required True type string path v1alpha/{+name}:accept request $ref GoogleFirebaseApptestersV1alphaAcceptInviteLinkRequest response $ref GoogleFirebaseApptestersV1alphaAcceptInviteLinkResponse scopes https://www.googleapis.com/auth/cloud-platform get description Get invite link. Invite links are created by developers. Developers can send a single link to multiple testers versus inviting testers one by one. Testers can use invite links to invite themselves to test an app. flatPath v1alpha/inviteLinks/{inviteLinksId} httpMethod GET id firebaseapptesters.inviteLinks.get parameterOrder name parameters name description Required. The name of the invite link to retrieve Format: inviteLinks/{invite_link} location path pattern ^inviteLinks/[^/]+$ required True type string path v1alpha/{+name} response $ref GoogleFirebaseApptestersV1alphaInviteLink scopes https://www.googleapis.com/auth/cloud-platform media methods upload description Uploads a feedback artifact flatPath v1alpha/projects/{projectsId}/installations/{installationsId}/releases/{releasesId}/feedbackReports/{feedbackReportsId}:uploadArtifact httpMethod POST id firebaseapptesters.media.upload mediaUpload accept */* protocols simple multipart True path /upload/v1alpha/{+feedbackReport}:uploadArtifact parameterOrder feedbackReport parameters feedbackReport description Required. The name of the feedback report resource. Format: projects/{project}/installations/{installation}/releases/{release}/feedbackReports/{feedback_report} location path pattern ^projects/[^/]+/installations/[^/]+/releases/[^/]+/feedbackReports/[^/]+$ required True type string path v1alpha/{+feedbackReport}:uploadArtifact request $ref GoogleFirebaseApptestersV1alphaUploadArtifactRequest response $ref GoogleFirebaseApptestersV1alphaUploadArtifactResponse scopes https://www.googleapis.com/auth/cloud-platform supportsMediaUpload True projects resources installations methods create description Create a new TesterAppInstallation record to register a Firebase Installation ID with a specific Tester to enable FID based auth from the SDK flatPath v1alpha/projects/{projectsId}/installations httpMethod POST id firebaseapptesters.projects.installations.create parameterOrder parent parameters fid description Required. The firebase installation id to register location query type string parent description Required. The parent resource where this TesterAppInstallation will be created Format: projects/{project} location path pattern ^projects/[^/]+$ required True type string testerAppId description The app id to link to the installation id location query type string path v1alpha/{+parent}/installations response $ref GoogleFirebaseApptestersV1alphaTesterAppInstallation scopes https://www.googleapis.com/auth/cloud-platform resources releases methods find description Find a release based on binary identifiers available to the SDK on device flatPath v1alpha/projects/{projectsId}/installations/{installationsId}/releases:find httpMethod GET id firebaseapptesters.projects.installations.releases.find parameterOrder parent parameters apkHash description Client-side computable APK hash (APKs only) location query type string compositeBinaryId.buildVersion description versionCode on Android, CFBundleVersion on iOS (e.g. "456") location query type string compositeBinaryId.codeHash description Hash of binary on Android, modified hash excluding app metadata (e.g. provisioning profile, version info) on iOS. NOTE - on iOS, releases with the same code but different version numbers will have the same code_hash NOTE - ad-hoc iOS releases with the same code but different provisioning profiles will have the same code_hash location query type string compositeBinaryId.displayVersion description versionName on Android, CFBundleShortVersionString on iOS (e.g. "1.2.3") location query type string iasArtifactId description IAS Artifact ID (AABs only) location query type string parent description Required. The parent, which owns the collection of installation releases Format: projects/{project}/installations/{installation} location path pattern ^projects/[^/]+/installations/[^/]+$ required True type string path v1alpha/{+parent}/releases:find response $ref GoogleFirebaseApptestersV1alphaFindReleaseResponse scopes https://www.googleapis.com/auth/cloud-platform list description List releases for an app by firebase installation id (FID) flatPath v1alpha/projects/{projectsId}/installations/{installationsId}/releases httpMethod GET id firebaseapptesters.projects.installations.releases.list parameterOrder parent parameters pageSize description Maximum number of releases to return format int32 location query type integer pageToken description Page token received from previous ListDevices call location query type string parent description Required. The parent, which owns the collection of installation releases Format: projects/{project}/installations/{installation} deprecated Format: devices/{device}/testerApps/{tester_app}/installations/{installation} location path pattern ^projects/[^/]+/installations/[^/]+$ required True type string path v1alpha/{+parent}/releases response $ref GoogleFirebaseApptestersV1alphaListTesterAppInstallationReleasesResponse scopes https://www.googleapis.com/auth/cloud-platform resources feedbackReports methods commit description Commits the feedback flatPath v1alpha/projects/{projectsId}/installations/{installationsId}/releases/{releasesId}/feedbackReports/{feedbackReportsId}:commit httpMethod POST id firebaseapptesters.projects.installations.releases.feedbackReports.commit parameterOrder name parameters name description Required. The name of the feedback location path pattern ^projects/[^/]+/installations/[^/]+/releases/[^/]+/feedbackReports/[^/]+$ required True type string path v1alpha/{+name}:commit request $ref GoogleFirebaseApptestersV1alphaCommitFeedbackReportRequest response $ref GoogleFirebaseApptestersV1alphaFeedbackReport scopes https://www.googleapis.com/auth/cloud-platform create description Create new feedback for a release flatPath v1alpha/projects/{projectsId}/installations/{installationsId}/releases/{releasesId}/feedbackReports httpMethod POST id firebaseapptesters.projects.installations.releases.feedbackReports.create parameterOrder parent parameters parent description Required. The parent resource that owns the feedback Format: projects/{project}/installations/{installation}/releases/{release} location path pattern ^projects/[^/]+/installations/[^/]+/releases/[^/]+$ required True type string path v1alpha/{+parent}/feedbackReports request $ref GoogleFirebaseApptestersV1alphaFeedbackReport response $ref GoogleFirebaseApptestersV1alphaFeedbackReport scopes https://www.googleapis.com/auth/cloud-platform v1alpha methods deleteDevices description Delete all devices flatPath v1alpha/devices httpMethod DELETE id firebaseapptesters.deleteDevices parameterOrder parameters path v1alpha/devices response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform revision 20250206 rootUrl https://firebaseapptesters.googleapis.com/ schemas GdataBlobstore2Info description Information to read/write to blobstore2. id GdataBlobstore2Info properties blobGeneration description The blob generation id. format int64 type string blobId description The blob id, e.g., /blobstore/prod/playground/scotty type string downloadReadHandle description Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads. format byte type string readToken description The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call. type string uploadMetadataContainer description Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads. format byte type string type object GdataCompositeMedia description A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. id GdataCompositeMedia properties blobRef deprecated True description Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef. format byte type string blobstore2Info $ref GdataBlobstore2Info description Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob. cosmoBinaryReference description A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. format byte type string crc32cHash description crc32.c hash for the payload. format uint32 type integer inline description Media data, set if reference_type is INLINE format byte type string length description Size of the data, in bytes format int64 type string md5Hash description MD5 hash for the payload. format byte type string objectId $ref GdataObjectId description Reference to a TI Blob, set if reference_type is BIGSTORE_REF. path description Path to the data, set if reference_type is PATH type string referenceType description Describes what the field reference contains. enum PATH BLOB_REF INLINE BIGSTORE_REF COSMO_BINARY_REFERENCE enumDescriptions Reference contains a GFS path or a local path. Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated. Data is included into this proto buffer Reference points to a bigstore object Indicates the data is stored in cosmo_binary_reference. type string sha1Hash description SHA-1 hash for the payload. format byte type string type object GdataContentTypeInfo description Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty. id GdataContentTypeInfo properties bestGuess description Scotty's best guess of what the content type of the file is. type string fromBytes description The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file. type string fromFileName description The content type of the file derived from the file extension of the original file name used by the client. type string fromHeader description The content type of the file as specified in the request headers, multipart headers, or RUPIO start request. type string fromUrlPath description The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API). type string type object GdataDiffChecksumsResponse description Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. id GdataDiffChecksumsResponse properties checksumsLocation $ref GdataCompositeMedia description Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol. chunkSizeBytes description The chunk size of checksums. Must be a multiple of 256KB. format int64 type string objectLocation $ref GdataCompositeMedia description If set, calculate the checksums based on the contents and return them to the caller. objectSizeBytes description The total size of the server object. format int64 type string objectVersion description The object version of the object the checksums are being returned for. type string type object GdataDiffDownloadResponse description Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. id GdataDiffDownloadResponse properties objectLocation $ref GdataCompositeMedia description The original object location. type object GdataDiffUploadRequest description A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. id GdataDiffUploadRequest properties checksumsInfo $ref GdataCompositeMedia description The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol. objectInfo $ref GdataCompositeMedia description The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. objectVersion description The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in. type string type object GdataDiffUploadResponse description Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. id GdataDiffUploadResponse properties objectVersion description The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload. type string originalObject $ref GdataCompositeMedia description The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification. type object GdataDiffVersionResponse description Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. id GdataDiffVersionResponse properties objectSizeBytes description The total size of the server object. format int64 type string objectVersion description The version of the object stored at the server. type string type object GdataDownloadParameters description Parameters specific to media downloads. id GdataDownloadParameters properties allowGzipCompression description A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client. type boolean ignoreRange description Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty. type boolean type object GdataMedia description A reference to data stored on the filesystem, on GFS or in blobstore. id GdataMedia properties algorithm deprecated True description Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time. type string bigstoreObjectRef deprecated True description Use object_id instead. format byte type string blobRef deprecated True description Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef. format byte type string blobstore2Info $ref GdataBlobstore2Info description Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob. compositeMedia description A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified. items $ref GdataCompositeMedia type array contentType description MIME type of the data type string contentTypeInfo $ref GdataContentTypeInfo description Extended content type information provided for Scotty uploads. cosmoBinaryReference description A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. format byte type string crc32cHash description For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported. format uint32 type integer diffChecksumsResponse $ref GdataDiffChecksumsResponse description Set if reference_type is DIFF_CHECKSUMS_RESPONSE. diffDownloadResponse $ref GdataDiffDownloadResponse description Set if reference_type is DIFF_DOWNLOAD_RESPONSE. diffUploadRequest $ref GdataDiffUploadRequest description Set if reference_type is DIFF_UPLOAD_REQUEST. diffUploadResponse $ref GdataDiffUploadResponse description Set if reference_type is DIFF_UPLOAD_RESPONSE. diffVersionResponse $ref GdataDiffVersionResponse description Set if reference_type is DIFF_VERSION_RESPONSE. downloadParameters $ref GdataDownloadParameters description Parameters for a media download. filename description Original file name type string hash deprecated True description Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media. type string hashVerified description For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification. type boolean inline description Media data, set if reference_type is INLINE format byte type string isPotentialRetry description |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence. type boolean length description Size of the data, in bytes format int64 type string md5Hash description Scotty-provided MD5 hash for an upload. format byte type string mediaId description Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA. format byte type string objectId $ref GdataObjectId description Reference to a TI Blob, set if reference_type is BIGSTORE_REF. path description Path to the data, set if reference_type is PATH type string referenceType description Describes what the field reference contains. enum PATH BLOB_REF INLINE GET_MEDIA COMPOSITE_MEDIA BIGSTORE_REF DIFF_VERSION_RESPONSE DIFF_CHECKSUMS_RESPONSE DIFF_DOWNLOAD_RESPONSE DIFF_UPLOAD_REQUEST DIFF_UPLOAD_RESPONSE COSMO_BINARY_REFERENCE ARBITRARY_BYTES enumDescriptions Reference contains a GFS path or a local path. Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated. Data is included into this proto buffer Data should be accessed from the current service using the operation GetMedia. The content for this media object is stored across multiple partial media objects under the composite_media field. Reference points to a bigstore object Indicates the data is stored in diff_version_response. Indicates the data is stored in diff_checksums_response. Indicates the data is stored in diff_download_response. Indicates the data is stored in diff_upload_request. Indicates the data is stored in diff_upload_response. Indicates the data is stored in cosmo_binary_reference. Informs Scotty to generate a response payload with the size specified in the length field. The contents of the payload are generated by Scotty and are undefined. This is useful for testing download speeds between the user and Scotty without involving a real payload source. Note: range is not supported when using arbitrary_bytes. type string sha1Hash description Scotty-provided SHA1 hash for an upload. format byte type string sha256Hash description Scotty-provided SHA256 hash for an upload. format byte type string timestamp description Time at which the media data was last updated, in milliseconds since UNIX epoch format uint64 type string token description A unique fingerprint/version id for the media data type string type object GdataObjectId description This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. id GdataObjectId properties bucketName description The name of the bucket to which this object belongs. type string generation description Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions format int64 type string objectName description The name of the object. type string type object GoogleApiHttpBody description Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. id GoogleApiHttpBody properties contentType description The HTTP Content-Type header value specifying the content type of the body. type string data description The HTTP request/response body as raw binary. format byte type string extensions description Application specific response metadata. Must be set in the first response for streaming APIs. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array type object GoogleFirebaseApptestersV1alphaAcceptInviteLinkRequest description The request object for the AcceptInviteLink call id GoogleFirebaseApptestersV1alphaAcceptInviteLinkRequest properties email description Email address type string type object GoogleFirebaseApptestersV1alphaAcceptInviteLinkResponse description The response object for the AcceptInviteLink call id GoogleFirebaseApptestersV1alphaAcceptInviteLinkResponse properties result description The result from accepting the invite link enum RESULT_UNSPECIFIED READY_TO_TEST AWAITING_RELEASE TESTER_LIMIT_REACHED INVALID_EMAIL enumDescriptions Default result. Unused. An invitation emails was sent to the tester. There is not yet an eligible release for this invite link, so no invitation was created The app has reached tester limit for group or project Invalid email type string type object GoogleFirebaseApptestersV1alphaCommitFeedbackReportRequest description Request message for `CommitFeedbackReport` id GoogleFirebaseApptestersV1alphaCommitFeedbackReportRequest properties type object GoogleFirebaseApptestersV1alphaConsentAppRequest description The request object for the ConsentApp call id GoogleFirebaseApptestersV1alphaConsentAppRequest properties invitation description Invitation name. Needed if this is the testers first time consenting to share the device's data for the app to verify that tester was invited to the app type string type object GoogleFirebaseApptestersV1alphaConsentAppResponse description The response object for the ConsentApp call id GoogleFirebaseApptestersV1alphaConsentAppResponse properties type object GoogleFirebaseApptestersV1alphaDevice description A representation of the testers device id GoogleFirebaseApptestersV1alphaDevice properties enrollIosDeviceUri description Uri to enroll the iOS device as a part of the apple OTA profile enrollment. Only present if the device is an iOS device and we don't already know its udid type string manufacturer description Manufacturer type string model description Model type string name description The name of the device Format: devices/{device} type string osVersion description OS version type string platform description Platform enum PLATFORM_UNSPECIFIED IOS ANDROID enumDescriptions Default value. This value is unused. IOS Android type string udid description The unique device identifier (iOS only) type string useragent description The user agent string from the browser (passed along in the proxy call). type string type object GoogleFirebaseApptestersV1alphaFeedbackReport description A representation of a release feedback id GoogleFirebaseApptestersV1alphaFeedbackReport properties name description The name of the feedback Format: projects/{project}/installations/{installation}/releases/{release}/feedbackReports/{feedback_report} type string text description The text elaborating on the feedback type string type object GoogleFirebaseApptestersV1alphaFindReleaseResponse description The response object for the FindRelease call id GoogleFirebaseApptestersV1alphaFindReleaseResponse properties release description The name of the release, if one is found type string type object GoogleFirebaseApptestersV1alphaInvitation description An invitation maps an email to an app. An invitation is required to link a testers device to an app via the ConsentApp call. id GoogleFirebaseApptestersV1alphaInvitation properties name description The name of the invitation to retrieve Format: invitations/{invitation} type string state description Invitation state enum INVITATION_STATE_UNSPECIFIED INVITED PENDING_ACCEPT ACCEPTED enumDescriptions Default value. This value is unused. Tester has received an email for the latest release Tester has received email for previous release, but has not received an email for the current release because they have not accepted the email to the previous release Tester has accepted an email for a release type string subscriptionState description Subscription state enum SUBSCRIPTION_STATE_UNSPECIFIED SUBSCRIBED UNSUBSCRIBED enumDescriptions Default value. This value is unused. Subscribed Unsubscribed type string testerApp $ref GoogleFirebaseApptestersV1alphaTesterApp description Information about the app that this invitation belongs to testerEmail description The tester email that the invite was sent to type string type object GoogleFirebaseApptestersV1alphaInviteLink description The representation of an invite link id GoogleFirebaseApptestersV1alphaInviteLink properties domainRestriction description Email domain restriction set by developer. Testers will only be able to accept invite links using an email with this domain. type string joinable description Whether or not this invite link can be joined (determined by tester limits) type boolean name description The name of the invite link Format: inviteLinks/{invite_link} type string testerApps description List of apps that the tester will be invited to after accepting items $ref GoogleFirebaseApptestersV1alphaTesterApp type array type object GoogleFirebaseApptestersV1alphaListDevicesResponse description Response object for ListDevices call id GoogleFirebaseApptestersV1alphaListDevicesResponse properties devices description List of devices items $ref GoogleFirebaseApptestersV1alphaDevice type array nextPageToken description A token which can be sent as `page_token` to retrieve the next page If this field is omitted, there are no subsequent pages type string type object GoogleFirebaseApptestersV1alphaListReleasesResponse description The response object for the ListReleases call id GoogleFirebaseApptestersV1alphaListReleasesResponse properties nextPageToken description A token which can be sent as `page_token` to retrieve the next page If this field is omitted, there are no subsequent pages type string releases description List of releases items $ref GoogleFirebaseApptestersV1alphaRelease type array type object GoogleFirebaseApptestersV1alphaListTesterAppInstallationReleasesResponse description The response object for the ListTesterAppInstallationReleases call id GoogleFirebaseApptestersV1alphaListTesterAppInstallationReleasesResponse properties nextPageToken description A token which can be sent as `page_token` to retrieve the next page If this field is omitted, there are no subsequent pages type string releases description List of releases items $ref GoogleFirebaseApptestersV1alphaRelease type array type object GoogleFirebaseApptestersV1alphaListTesterAppsResponse description The response object for the ListTesterApps call id GoogleFirebaseApptestersV1alphaListTesterAppsResponse properties nextPageToken description A token which can be sent as `page_token` to retrieve the next page If this field is omitted, there are no subsequent pages type string testerApps description List of tester apps items $ref GoogleFirebaseApptestersV1alphaTesterApp type array type object GoogleFirebaseApptestersV1alphaRelease description A representation of an app release id GoogleFirebaseApptestersV1alphaRelease properties apkHash description Computationally-efficient hash of an apk. This value is computed in our backend and our Android SDK by zipping the apk file. Used by the SDK to map a release on the device to a release returned from the server. type string binaryType description Type of binary enum BINARY_TYPE_UNSPECIFIED IPA APK AAB enumDescriptions Binary type unspecified iOS app store package Android application package Android app bundle type string buildVersion description versionCode on Android, CFBundleVersion on iOS (e.g. "456") type string codeHash description Hash of binary on Android, modified hash excluding app metadata (e.g. provisioning profile, version info) on iOS. NOTE - on iOS, releases with the same code but different version numbers will have the same code_hash NOTE - ad-hoc iOS releases with the same code but different provisioning profiles will have the same code_hash type string displayVersion description versionName on Android, CFBundleShortVersionString on iOS (e.g. "1.2.3") type string distributionMissingReason description Reason (if any) why the release is missing a distribution for this device enum DISTRIBUTION_MISSING_REASON_UNSPECIFIED NO_DISTRIBUTIONS WRONG_DEVICE NO_ARCHITECTURE OLD_OS_VERSION NO_UDID enumDescriptions Distribution missing reason unspecified Build is unavailable Device not supported Device not supported Device OS version not supported Waiting for developer to add device's UDID to the release type string downloadUrl description Short-lived download URL type string enterprise description Whether or not this is an enterprise release (vs. ad-hoc) for iOS type boolean expirationTime description The time at which this Release will expire format google-datetime type string fileSize description App binary file size format int64 type string iasArtifactId description IAS artifact id This value is inserted into the manifest of APK's installed via IAS in the com.android.vending.internal.apk.id metadata field Used to map a release to an APK installed via an app bundle type string latest description Whether or not this is the latest release that the tester has been added to type boolean name description The name of the release Format: devices/{device}/testerApps/{tester_app}/releases/{release} type string releaseNotes description Release notes type string releaseTime description Timestamp when the initial invitation(s) were sent for the release format google-datetime type string type object GoogleFirebaseApptestersV1alphaSubscribeInvitationRequest description The request object for the SubscribeInvitation call id GoogleFirebaseApptestersV1alphaSubscribeInvitationRequest properties type object GoogleFirebaseApptestersV1alphaTesterApp description A representation of an app. id GoogleFirebaseApptestersV1alphaTesterApp properties bundleId description The bundle identifier of the app type string consented description Tester has consented to share the device's data for the app type boolean contactEmail description Developer contact email for testers to reach out to about privacy or support issues. type string display description Display name of the app type string iconUrl description URL of app icon type string name description The name of the tester app to retrieve Format: devices/{device}/testerApps/{tester_app} type string pendingInvitation description The name of the invitation for this tester app. Set if the invitation is pending. Used by clients to bring testers to the invite acceptance page. type string platform description The platform of the app (iOS or Android) type string releaseCount description Number of releases for the app format int32 type integer type object GoogleFirebaseApptestersV1alphaTesterAppInstallation description The TesterAppInstallation resource id GoogleFirebaseApptestersV1alphaTesterAppInstallation properties name description Required. The TesterAppInstallation resource name Format: projects/{project}/installations/{installation} type string type object GoogleFirebaseApptestersV1alphaUnsubscribeInvitationRequest description The request object for the UnsubscribeInvitation call id GoogleFirebaseApptestersV1alphaUnsubscribeInvitationRequest properties type object GoogleFirebaseApptestersV1alphaUploadArtifactRequest description Request message for `UploadArtifact`. id GoogleFirebaseApptestersV1alphaUploadArtifactRequest properties artifact $ref GdataMedia description Required. Artifact to upload type description Required. Type of feedback artifact enum TYPE_UNSPECIFIED SCREENSHOT enumDescriptions Artifact type unspecified A screenshot illustrating the issue type string type object GoogleFirebaseApptestersV1alphaUploadArtifactResponse description Response message for `UploadFArtifact`. id GoogleFirebaseApptestersV1alphaUploadArtifactResponse properties type object GoogleProtobufEmpty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id GoogleProtobufEmpty properties type object servicePath title Firebase App Testers API version v1alpha version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/firebaseapptesters-v1	values_changed root new_value basePath baseUrl https://firebaseapptesters.googleapis.com/ batchPath batch canonicalName Firebaseapptesters description discoveryVersion v1 documentationLink https://firebase.google.com/products/app-distribution fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id firebaseapptesters:v1 kind discovery#restDescription mtlsRootUrl https://firebaseapptesters.mtls.googleapis.com/ name firebaseapptesters ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources revision 20250206 rootUrl https://firebaseapptesters.googleapis.com/ schemas servicePath title Firebase App Testers API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/firebaseapptesters-v1alpha	values_changed root['revision'] new_value 20250206 old_value 20250127
prod/firebasedatabase-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebasedatabase-v1beta	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebasedataconnect-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/firebasedataconnect-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/firebasedataconnect-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/firebasedataconnect-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/firebaseextensions-	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/firebase description View and administer all your Firebase data and settings https://www.googleapis.com/auth/firebase.readonly description View all your Firebase data and settings basePath baseUrl https://firebaseextensions.googleapis.com/ batchPath batch canonicalName Firebaseextensions description discoveryVersion v1 documentationLink https://firebase.google.com fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id firebaseextensions:v1beta kind discovery#restDescription mtlsRootUrl https://firebaseextensions.mtls.googleapis.com/ name firebaseextensions ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects methods getPublisherProfile description Gets a PublisherProfile for a Project. flatPath v1beta/projects/{projectsId}/publisherProfile httpMethod GET id firebaseextensions.projects.getPublisherProfile parameterOrder name parameters name description Required. The name of the PublisherProfile. e.g. `projects/23427309/publisherProfile` or `projects/project-id/publisherProfile` location path pattern ^projects/[^/]+/publisherProfile$ required True type string publisherId description Pass “-” for project ID with this query param, to lookup publisher project using the publisher ID. location query type string path v1beta/{+name} response $ref GoogleFirebaseExtensionsV1betaPublisherProfile scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly resources instances methods create description Creates a Extension Instance in a Project. flatPath v1beta/projects/{projectsId}/instances httpMethod POST id firebaseextensions.projects.instances.create parameterOrder parent parameters instanceId description The ID to use for the Extension Instance, which will become the final component of the instance's name. location query type string parent description Required. The project in which we are creating a Extension Instance. e.g. `projects/{project_id}` location path pattern ^projects/[^/]+$ required True type string validateOnly description Optional. If true, the request will just be valdated, not executed. location query type boolean path v1beta/{+parent}/instances request $ref GoogleFirebaseExtensionsV1betaExtensionInstance response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase delete description Deletes a Extension Instance. flatPath v1beta/projects/{projectsId}/instances/{instancesId} httpMethod DELETE id firebaseextensions.projects.instances.delete parameterOrder name parameters name description Required. The name of the Extension Instance to delete. e.g. `projects/{project_id}/instances/{instance_id}` location path pattern ^projects/[^/]+/instances/[^/]+$ required True type string path v1beta/{+name} response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase get description Gets a Extension Instance. flatPath v1beta/projects/{projectsId}/instances/{instancesId} httpMethod GET id firebaseextensions.projects.instances.get parameterOrder name parameters name description Required. The name of the Extension Instance to fetch. e.g. `projects/{project_id}/instances/{instance_id}` location path pattern ^projects/[^/]+/instances/[^/]+$ required True type string path v1beta/{+name} response $ref GoogleFirebaseExtensionsV1betaExtensionInstance scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly getRuntimeData description Gets the runtime data for an extension instance. flatPath v1beta/projects/{projectsId}/instances/{instancesId}/runtimeData httpMethod GET id firebaseextensions.projects.instances.getRuntimeData parameterOrder name parameters name description Required. The resource name of the Extension Instance Runtime Data to return. location path pattern ^projects/[^/]+/instances/[^/]+/runtimeData$ required True type string path v1beta/{+name} response $ref GoogleFirebaseExtensionsV1betaRuntimeData list description Lists Extension Instances in a Project. flatPath v1beta/projects/{projectsId}/instances httpMethod GET id firebaseextensions.projects.instances.list parameterOrder parent parameters pageSize description The number of results to return. Defaults to 50. format int32 location query type integer pageToken description Pagination token from a previous request. location query type string parent description Required. The project in which we are listing Extension Instances. location path pattern ^projects/[^/]+$ required True type string path v1beta/{+parent}/instances response $ref GoogleFirebaseExtensionsV1betaListExtensionInstancesResponse scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly patch description Updates a Extension Instance. flatPath v1beta/projects/{projectsId}/instances/{instancesId} httpMethod PATCH id firebaseextensions.projects.instances.patch parameterOrder name parameters name description Required. The name of the Extension Instance to update. e.g. `projects/{project_id}/instances/{instance_id}` location path pattern ^projects/[^/]+/instances/[^/]+$ required True type string updateMask description A set of field names to update in the Extension Instance. A value will only be updated if and only if it is included in the update mask. format google-fieldmask location query type string validateOnly description Optional. If true, the request will just be valdated, not executed. location query type boolean path v1beta/{+name} request $ref GoogleFirebaseExtensionsV1betaExtensionInstance response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase updateRuntimeData description Updates the runtime data for an extension instance. flatPath v1beta/projects/{projectsId}/instances/{instancesId}/runtimeData httpMethod PATCH id firebaseextensions.projects.instances.updateRuntimeData parameterOrder name parameters name description The name of the Extension Instance Runtime Data resource. location path pattern ^projects/[^/]+/instances/[^/]+/runtimeData$ required True type string updateMask description Optional. The Field mask to support partial updates. format google-fieldmask location query type string path v1beta/{+name} request $ref GoogleFirebaseExtensionsV1betaRuntimeData response $ref GoogleFirebaseExtensionsV1betaRuntimeData scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase resources runtimeData methods getIamPolicy description flatPath v1beta/projects/{projectsId}/instances/{instancesId}/runtimeData:getIamPolicy httpMethod POST id firebaseextensions.projects.instances.runtimeData.getIamPolicy parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/instances/[^/]+/runtimeData$ required True type string path v1beta/{+resource}:getIamPolicy request $ref GoogleIamV1GetIamPolicyRequest response $ref GoogleIamV1Policy setIamPolicy description flatPath v1beta/projects/{projectsId}/instances/{instancesId}/runtimeData:setIamPolicy httpMethod POST id firebaseextensions.projects.instances.runtimeData.setIamPolicy parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/instances/[^/]+/runtimeData$ required True type string path v1beta/{+resource}:setIamPolicy request $ref GoogleIamV1SetIamPolicyRequest response $ref GoogleIamV1Policy testIamPermissions description flatPath v1beta/projects/{projectsId}/instances/{instancesId}/runtimeData:testIamPermissions httpMethod POST id firebaseextensions.projects.instances.runtimeData.testIamPermissions parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/instances/[^/]+/runtimeData$ required True type string path v1beta/{+resource}:testIamPermissions request $ref GoogleIamV1TestIamPermissionsRequest response $ref GoogleIamV1TestIamPermissionsResponse operations methods get description Gets an Operation. flatPath v1beta/projects/{projectsId}/operations/{operationsId} httpMethod GET id firebaseextensions.projects.operations.get parameterOrder name parameters name description Required. The name of the long running Operation. e.g. `projects/{project_id}/operations/{operation_id}` location path pattern ^projects/[^/]+/operations/[^/]+$ required True type string path v1beta/{+name} response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly publisherProfile methods register description Register a PublisherProfile for a Project. flatPath v1beta/projects/{projectsId}/publisherProfile:register httpMethod POST id firebaseextensions.projects.publisherProfile.register parameterOrder parent parameters parent description Required. The project for which we are registering a PublisherProfile. e.g. `projects/23427309` or `projects/project-id` location path pattern ^projects/[^/]+$ required True type string path v1beta/{+parent}/publisherProfile:register request $ref GoogleFirebaseExtensionsV1betaPublisherProfile response $ref GoogleFirebaseExtensionsV1betaPublisherProfile scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase sources methods create description Creates a Extension Source. flatPath v1beta/projects/{projectsId}/sources httpMethod POST id firebaseextensions.projects.sources.create parameterOrder parent parameters parent description Required. The project in which we are creating a Extension Source. location path pattern ^projects/[^/]+$ required True type string path v1beta/{+parent}/sources request $ref GoogleFirebaseExtensionsV1betaExtensionSource response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase get description Gets a Extension Source. flatPath v1beta/projects/{projectsId}/sources/{sourcesId} httpMethod GET id firebaseextensions.projects.sources.get parameterOrder name parameters name description Required. The identifier of the Extension Source to return. e.g. `projects/{project_id}/sources/{source_id}` location path pattern ^projects/[^/]+/sources/[^/]+$ required True type string path v1beta/{+name} response $ref GoogleFirebaseExtensionsV1betaExtensionSource scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly publishers resources extensions methods batchGet description Gets up to 1K extensions in a batch. flatPath v1beta/publishers/{publishersId}/extensions:batchGet httpMethod GET id firebaseextensions.publishers.extensions.batchGet parameterOrder parent parameters names description Required. The names of the extensions to retrieve. A maximum of 1000 extensions can be retrieved in a batch. Format: publishers/{publisher}/extensions/{extension} location query repeated True type string parent description The parent resource shared by all extensions being retrieved. Format: publishers/{publisher} If this is set, the parent of all of the extensions specified in `names` must match this field. location path pattern ^publishers/[^/]+$ required True type string path v1beta/{+parent}/extensions:batchGet response $ref GoogleFirebaseExtensionsV1betaBatchGetExtensionsResponse scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly delete description Deletes an Extension. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId} httpMethod DELETE id firebaseextensions.publishers.extensions.delete parameterOrder name parameters name description Required. The name of the Extension we want to delete. e.g. `publishers/publisher-id/extensions/extension-id` location path pattern ^publishers/[^/]+/extensions/[^/]+$ required True type string path v1beta/{+name} response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase get description Gets an Extension. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId} httpMethod GET id firebaseextensions.publishers.extensions.get parameterOrder name parameters name description Required. The name of the Extension. e.g. `publishers/publisher-id/extensions/extension-id` location path pattern ^publishers/[^/]+/extensions/[^/]+$ required True type string path v1beta/{+name} response $ref GoogleFirebaseExtensionsV1betaExtension scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly list description Lists all Extensions for a Publisher. flatPath v1beta/publishers/{publishersId}/extensions httpMethod GET id firebaseextensions.publishers.extensions.list parameterOrder parent parameters filter description Filter which extensions are returned, per https://google.aip.dev/160. Uses EBNF grammar https://google.aip.dev/assets/misc/ebnf-filtering.txt. location query type string pageSize description The number of results to return. Defaults to 50. format int32 location query type integer pageToken description Pagination token from a previous request. location query type string parent description Required. The Publisher which we are listing Extensions for. e.g. `publishers/publisher-id`. Use `publishers/-` to query cross resources. location path pattern ^publishers/[^/]+$ required True type string path v1beta/{+parent}/extensions response $ref GoogleFirebaseExtensionsV1betaListExtensionsResponse scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly unpublish deprecated True description Unpublishes an Extension. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}:unpublish httpMethod POST id firebaseextensions.publishers.extensions.unpublish parameterOrder name parameters name description Required. The name of the Extension we want to unpublish. e.g. `publishers/publisher-id/extensions/extension-id` location path pattern ^publishers/[^/]+/extensions/[^/]+$ required True type string path v1beta/{+name}:unpublish request $ref GoogleFirebaseExtensionsV1betaUnpublishExtensionRequest response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase resources versions methods delete description Deletes an ExtensionVersion. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions/{versionsId} httpMethod DELETE id firebaseextensions.publishers.extensions.versions.delete parameterOrder name parameters name description Required. The name of the ExtensionVersion we want to delete. e.g. `publishers/publisher-id/extensions/extension-id/versions/1.2.3` location path pattern ^publishers/[^/]+/extensions/[^/]+/versions/[^/]+$ required True type string path v1beta/{+name} response $ref GoogleProtobufEmpty deprecate description Deprecates an ExtensionVersion. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions/{versionsId}:deprecate httpMethod POST id firebaseextensions.publishers.extensions.versions.deprecate parameterOrder name parameters name description Required. The name of the ExtensionVersion we want to deprecate. e.g. `publishers/publisher-id/extensions/extension-id/versions/1.2.3` location path pattern ^publishers/[^/]+/extensions/[^/]+/versions/[^/]+$ required True type string path v1beta/{+name}:deprecate request $ref GoogleFirebaseExtensionsV1betaDeprecateExtensionVersionRequest response $ref GoogleFirebaseExtensionsV1betaExtensionVersion scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase get description Gets an ExtensionVersion. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions/{versionsId} httpMethod GET id firebaseextensions.publishers.extensions.versions.get parameterOrder name parameters name description Required. The name of the ExtensionVersion. e.g. `publishers/publisher-id/extensions/extension-id/versions/1.2.3` or `publishers/publisher-id/extensions/extension-id/versions/latest` location path pattern ^publishers/[^/]+/extensions/[^/]+/versions/[^/]+$ required True type string path v1beta/{+name} response $ref GoogleFirebaseExtensionsV1betaExtensionVersion scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly list description Lists all ExtensionVersions for an Extension. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions httpMethod GET id firebaseextensions.publishers.extensions.versions.list parameterOrder parent parameters filter description Filter which versions of this extension are returned, per https://google.aip.dev/160. Uses EBNF grammar https://google.aip.dev/assets/misc/ebnf-filtering.txt. location query type string pageSize description The number of results to return. Defaults to 50. format int32 location query type integer pageToken description Pagination token from a previous request. location query type string parent description Required. The name of the Extenson that we are listing ExtensionVersions for for. e.g. `publishers/publisher_id/extensions/extension_id` location path pattern ^publishers/[^/]+/extensions/[^/]+$ required True type string showPrereleases description Include pre-release ExtensionVersions. location query type boolean path v1beta/{+parent}/versions response $ref GoogleFirebaseExtensionsV1betaListExtensionVersionsResponse scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly publish description Publishes an ExtensionVersion. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions:publish httpMethod POST id firebaseextensions.publishers.extensions.versions.publish parameterOrder parent parameters parent description Required. The Publisher and Extension for the ExtensionVersion. e.g. `publishers/publisher-id/extensions/extension-id` location path pattern ^publishers/[^/]+/extensions/[^/]+$ required True type string path v1beta/{+parent}/versions:publish request $ref GoogleFirebaseExtensionsV1betaPublishExtensionVersionRequest response $ref GoogleLongrunningOperation scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase undeprecate description Un-deprecates an ExtensionVersion. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions/{versionsId}:undeprecate httpMethod POST id firebaseextensions.publishers.extensions.versions.undeprecate parameterOrder name parameters name description Required. The name of the ExtensionVersion we want to un-deprecate. e.g. `publishers/publisher-id/extensions/extension-id/versions/1.2.3` location path pattern ^publishers/[^/]+/extensions/[^/]+/versions/[^/]+$ required True type string path v1beta/{+name}:undeprecate request $ref GoogleFirebaseExtensionsV1betaUndeprecateExtensionVersionRequest response $ref GoogleFirebaseExtensionsV1betaExtensionVersion scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase unpublish deprecated True description Unpublishes an ExtensionVersion. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions/{versionsId}:unpublish httpMethod POST id firebaseextensions.publishers.extensions.versions.unpublish parameterOrder name parameters name description Required. The name of the ExtensionVersion we want to unpublish. e.g. `publishers/publisher-id/extensions/extension-id/versions/1.2.3` location path pattern ^publishers/[^/]+/extensions/[^/]+/versions/[^/]+$ required True type string path v1beta/{+name}:unpublish request $ref GoogleFirebaseExtensionsV1betaUnpublishExtensionVersionRequest response $ref GoogleProtobufEmpty scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase revision 20250205 rootUrl https://firebaseextensions.googleapis.com/ schemas GoogleFirebaseExtensionsV1betaApi description Representation of a Google API that is used by this Extension. id GoogleFirebaseExtensionsV1betaApi properties apiName description Required. Name of API. type string reason description Optional. Reason the API needs to be enabled. type string type object GoogleFirebaseExtensionsV1betaAuthor description Representation of contact information associated with a human being or organization. Used to represent the author or creator of the Extension. id GoogleFirebaseExtensionsV1betaAuthor properties authorName description Required. Name of the author. type string email description Optional. Public email of the author. type string url description Optional. URL for GitHub, Twitter, or website associated with the author. type string type object GoogleFirebaseExtensionsV1betaBatchGetExtensionsResponse description Response object for BatchGetExtensions. id GoogleFirebaseExtensionsV1betaBatchGetExtensionsResponse properties extensions description Extensions requested. items $ref GoogleFirebaseExtensionsV1betaExtension type array type object GoogleFirebaseExtensionsV1betaDeprecateExtensionVersionRequest description Used to deprecate an ExtensionVersion. id GoogleFirebaseExtensionsV1betaDeprecateExtensionVersionRequest properties deprecationMessage description Deprecation message. This will appear alongside any warnings to update. type string type object GoogleFirebaseExtensionsV1betaEventDescriptor description EventDescriptor contains the minimum information to describe a CloudEvent. id GoogleFirebaseExtensionsV1betaEventDescriptor properties description description Required. Description of the event. type string type description Required. The type of the event. Should follow CloudEvent schema requirements for "type" field. https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type type string type object GoogleFirebaseExtensionsV1betaExtension description An `Extension` is a published extension, for sharing with other users. id GoogleFirebaseExtensionsV1betaExtension properties createTime description Output only. Creation time. format google-datetime readOnly True type string deleteTime description Output only. Deletion time. format google-datetime readOnly True type string iconUri description Output only. Uri of the extension’s icon. e.g. a g-static or Cloud Storage URL readOnly True type string latestApprovedVersion description Output only. ID of the latest approved ExtensionVersion that corresponds to this Extension, according to semver versioning (e.g. 0.3.3). readOnly True type string latestVersion description Output only. ID of the latest verifiable stable ExtensionVersion that corresponds to this Extension, according to semver versioning (e.g. 0.3.3). readOnly True type string latestVersionCreateTime description Output only. Time of when the latest ExtensionVersion was created. format google-datetime readOnly True type string metrics $ref GoogleFirebaseExtensionsV1betaExtensionMetrics description Output only. Metrics of the Extension, such as active install count readOnly True name description Output only. Fully qualified name of Extension (e.g. publishers/publisher-id/extensions/awesome-extension) readOnly True type string publisher $ref GoogleFirebaseExtensionsV1betaPublisherSummary description Publisher detail about the extension author. ref description Output only. User-friendly identifier for the Extension (e.g. publisher-id/awesome-extension) readOnly True type string registryLaunchStage description Output only. Launch stage of the extension. Used to control badges displayed on extensions to end user. enum REGISTRY_LAUNCH_STAGE_UNSPECIFIED EXPERIMENTAL BETA GA DEPRECATED enumDescriptions Default state. Generally not used. Can be installed by consumers. User displayed warning shown that this is not officially supported. Can be installed by consumers. No warnings displayed, but no deprecation policy. Can be installed by consumers. No warnings displayed, but includes deprecation policy. Can be installed by consumers. User displayed warning that there will no longer be future updates. readOnly True type string repoUri description Output only. URI of the Extension's public Git repository. readOnly True type string state description Output only. State of the extension. enum STATE_UNSPECIFIED PUBLISHED DEPRECATED enumDescriptions Default state. Generally not used. Can be installed by consumers. Cannot be installed by consumers. Automatically set when all versions have been deprecated. Returns to PUBLISHED state when a new version is published. readOnly True type string tags description Output only. A list of extension tags from the latest approved version items type string readOnly True type array visibility deprecated True description Output only. Deprecated. Visibility of the extension on public directories. enum VISIBILITY_UNSPECIFIED UNLISTED PUBLIC enumDescriptions Default state. Generally not used. Not visible in search/list APIs. Extension is installable via direct link only. Discoverable in search/list APIs. readOnly True type string type object GoogleFirebaseExtensionsV1betaExtensionInstance description An `ExtensionInstance` is an installation of an Extension into a user's project. id GoogleFirebaseExtensionsV1betaExtensionInstance properties config $ref GoogleFirebaseExtensionsV1betaExtensionInstanceConfig description Required. The current Config of the Extension Instance. createTime description Output only. The time at which the Extension Instance was created. format google-datetime readOnly True type string errorStatus $ref GoogleRpcStatus description Output only. If this Instance has `state: ERRORED`, the error messages will be found here. readOnly True etag description A weak etag that is computed by the server based on other configuration values and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. type string labels additionalProperties type string description Optional. A set of (internal use) labels that can be used to identify extension instance attributes such as how the extension was installed. type object lastOperationName description Output only. The name of the last operation that acted on this Extension Instance. e.g. `operations/{operation_id}` readOnly True type string lastOperationType description Output only. The type of the last operation that acted on the Extension Instance. enum INSTANCE_OPERATION_TYPE_UNSPECIFIED CREATE UPDATE CONFIGURE DELETE enumDescriptions Creating an Extension Instance. Updating an Extension Instance. Configuring an Extension Instance. Deleting an Extension Instance. readOnly True type string name description Output only. The name of the Extension Instance. e.g. `projects/{project_id}/instances/{instance_id}` readOnly True type string runtimeData $ref GoogleFirebaseExtensionsV1betaRuntimeData description Output only. Data set by the extension instance at runtime. readOnly True serviceAccountEmail description Optional. The email of the service account to be used at runtime by compute resources created for the operation of the Extension instance. type string state description Output only. The current state of the Extension Instance. enum STATE_UNSPECIFIED DEPLOYING UNINSTALLING ACTIVE ERRORED PAUSED enumDescriptions The default state. Generally not used for long. The Extension Instance is waiting on an Operation to complete. Could resolve to `ACTIVE`, `PAUSED`, `ERRORED`. The Extension Instance is being removed from the project. Could resolve to `ERRORED`, but more likely the instance will soon cease to exist. The Extension Instance is installed and ready. The Extension Instance encountered an error while `DEPLOYING` or `UNINSTALLING`. The Extension's resources have been removed from the project, but the Config remains so the Instance can be restored. readOnly True type string updateTime description Output only. The time at which the Extension Instance was updated. format google-datetime readOnly True type string type object GoogleFirebaseExtensionsV1betaExtensionInstanceConfig description A configuration of an Extension Instance. This is used by an Extension Instance to specify the ExtensionSource and environment configuration at a given time. id GoogleFirebaseExtensionsV1betaExtensionInstanceConfig properties allowedEventTypes description Optional. List of extension events selected by consumer that extension is allowed to emit, identified by their types. items type string type array createTime description Output only. The time at which the Extension Instance Config was created. format google-datetime readOnly True type string eventarcChannel description Optional. Fully qualified Eventarc resource name that consumers should use for event triggers. Follows the format `projects/{project_id}/locations/{location}/channels/{channel_id}` Extensions emit events using Eventarc as the underlying eventing solution, but the design should be agnostic such that we could switch to another eventing solution in the future. type string extensionRef description Optional. If this extension is installed from the Registry, the ref of the Extension. (e.g. publisher-id/awesome-extension) Either extension_ref or source.name must be provided when creating an extension instance. type string extensionVersion description Optional. If this extension is installed from the Registry, the ID of the version. (e.g. 1.0.3). If left blank, latest is assumed. type string name description Output only. The unique identifier for this configuration. e.g. `projects/{project_id}/instances/{instance_id}/configs/{config_id}` readOnly True type string params additionalProperties type string description Required. The value of configuration parameters from the ExtensionSpec (see `source.spec`). type object populatedPostinstallContent description Output only. Postinstall instructions to be shown for this Extension, with template strings representing function and parameter values substituted with actual values. These strings include: ${param:FOO}, ${function:myFunc.url}, ${function:myFunc.name}, and ${function:myFunc.location} readOnly True type string source $ref GoogleFirebaseExtensionsV1betaExtensionSource description Optional. The ExtensionSource used to install this Extension Instance. systemParams additionalProperties type string description Optional. Param values that are only available at deployment time. Unlike other params, these will not be set as environment variables on functions. type object type object GoogleFirebaseExtensionsV1betaExtensionMetrics description ExtensionMetrics contains metrics for Extensions, such as aggregated active instance count id GoogleFirebaseExtensionsV1betaExtensionMetrics properties activeInstallCount description The approximate count of active installs of all versions. format int64 type string type object GoogleFirebaseExtensionsV1betaExtensionSource description The source of the Extension Instance. id GoogleFirebaseExtensionsV1betaExtensionSource properties extensionRoot description The directory location of extension.yaml in the archived package. If none is specified, than the package root is assumed ("/"). type string fetchTime description Output only. The time at which the ExtensionSource was initially fetched. format google-datetime readOnly True type string hash description Output only. SHA256 hash of the archive (`package_uri`) at processing time. readOnly True type string iconUri description Output only. The uri of the icon found in this source. readOnly True type string lastOperationName description Output only. The name of the last operation that acted on this ExtensionSource. e.g. `operations/{operation_id}` readOnly True type string name description Output only. The unique identifier for this source. e.g. `projects/{project_id}/sources/{source_id}` readOnly True type string packageUri description Required. A URI of a zip or tar archive of an Extension package. e.g. `https://example.com/path/to/archive.zip` This is used to create the ExtensionSource, and is not guaranteed to still exist after the ExtensionSource has been created. type string spec $ref GoogleFirebaseExtensionsV1betaExtensionSpec description Output only. The specification for this Extension. readOnly True state description Output only. The current state of the Extension Source. enum STATE_UNSPECIFIED ACTIVE DELETED enumDescriptions The default state. Not used typically. Source still exists. Source was deleted. readOnly True type string type object GoogleFirebaseExtensionsV1betaExtensionSpec description The specification of an Extension. id GoogleFirebaseExtensionsV1betaExtensionSpec properties apis description Optional. List of Google APIs that will be enabled on a project as part of the install process of this Extension. items $ref GoogleFirebaseExtensionsV1betaApi type array author $ref GoogleFirebaseExtensionsV1betaAuthor description Optional. Primary author of the Extension and point of contact for Extension information. billingRequired description Optional. Indicator if an associated billing account is needed to use this Extension. Defaults to false. type boolean contributors description Optional. Multiple authors of the Extension. Used to give credit to other contributors to the Extension beyond the author. items $ref GoogleFirebaseExtensionsV1betaAuthor type array description description Optional. Description of the Extension. type string displayName description Optional. Human-readable name of the Extension (e.g. "Image Resizer"). type string events description Optional. A list of descriptors describing what events are emitted by this extension. items $ref GoogleFirebaseExtensionsV1betaEventDescriptor type array externalServices items $ref GoogleFirebaseExtensionsV1betaExternalService type array icon description Optional. Icon filename. e.g. icon.png The icon must be present in the same directory as the extension.yaml file. The icon must be square. The icon must be PNG. The icon must be between 512 - 1024 pixels per side. We recommend icons exactly 512x512. Larger icons will be automatically resized to 512x512. Icon is not a required field. If no icon is specified, a default icon will be shown instead. type string license description Optional. License information for the Extension. Should follow SPDX format. See: https://spdx.org/licenses/ type string lifecycleEvents description Optional. A List of things to execute at certain lifecycle stages. items $ref GoogleFirebaseExtensionsV1betaLifecycleEvent type array name description Required. Name of the Extension. This is an identifier the publisher chooses when publishing this extension onto the registry, and is part of the extension ref. (e.g. "storage_resize_images") type string params description Optional. List of environment variables that may be configured for the Extension. items $ref GoogleFirebaseExtensionsV1betaExtensionSpecParameter type array postinstallContent description Output only. Any postinstall instructions to be shown for this Extension. readOnly True type string preinstallContent description Output only. Any preinstall instructions to be shown for this Extension. readOnly True type string readmeContent description Output only. Any README content to be shown for this Extension. readOnly True type string releaseNotesUrl description Optional. URL of where the release notes can be found. type string resources description Required. List of Resources that will be created in installation. items $ref GoogleFirebaseExtensionsV1betaResource type array roles description Optional. List of IAM roles that define the access the Extension will have in the project. items $ref GoogleFirebaseExtensionsV1betaRole type array sourceUrl description Optional. URL where the source code of the Extension can be found. type string specVersion description Required. Version of the Extension Specification used. type string systemParams description Output only. Params whose values are only available at deployment time. Unlike other params, these will not be set as environment variables on functions. items $ref GoogleFirebaseExtensionsV1betaExtensionSpecParameter readOnly True type array tags description Optional. A list of extension tags items type string type array version description Required. Version of the Extension. type string type object GoogleFirebaseExtensionsV1betaExtensionSpecParameter description Representation of a configurable parameter for an Extension. These can be used to configure resources or referenced as environment variables in a Cloud Function. id GoogleFirebaseExtensionsV1betaExtensionSpecParameter properties advanced description Optional. Whether a param is meant for all users, or just advanced users. Advanced params are displayed separately and are hidden at first. type boolean default description Optional. Default value if an Extension consumer leaves the parameter value blank. type string description description Optional. Additional description for the parameter. It will be shown to the Extension consumer when they are prompted for the parameter value. Markdown is supported. type string example description Optional. Example of what this value might look like. type string immutable description Optional. Whether or not the user should be prevented from updating the value of this parameter later. Defaults to false. type boolean label description Required. Label for the parameter, shown to the Extension consumer when they are prompted for the parameter value. type string options description Optional. A list of values that the consumer can pick from, if the param.Type is select or multiSelect items $ref GoogleFirebaseExtensionsV1betaParamSelectOption type array param description Required. Name of the parameter. type string required description Optional. Flag indicating if the parameter must be defined and not empty. Defaults to false. type boolean resourceInfo $ref GoogleFirebaseExtensionsV1betaResourceInfo description Optional. Additional resource information which must be specified when parameter type is RESOURCE. type description Optional. Type of input. If unspecified, it is assumed to be STRING. enum EXTENSION_SPEC_PARAMETER_TYPE_UNSPECIFIED STRING SELECT MULTISELECT SELECT_RESOURCE SECRET enumDescriptions Param is a free-form string input. Param allows selecting one option to be its value. Param allows selecting multiple options. Param allows specifying some external resource, ex. Cloud Storage bucket. Param represents a Cloud Secret Manager Secret. type string validationErrorMessage description Optional. Error message to display if regex validation fails. type string validationRegex description Optional. Regex string for validation of the parameter value provided by the Extension consumer. type string type object GoogleFirebaseExtensionsV1betaExtensionVersion description An ExtensionVersion is a published version of an Extension, for sharing with other users. id GoogleFirebaseExtensionsV1betaExtensionVersion properties buildSourceUri description Output only. Git commit URI (e.g. github.com///tree/) that this ExtensionVersion was built from. Empty if not a verifiable version. readOnly True type string createTime description Output only. Time of creation. format google-datetime readOnly True type string deleteTime description Output only. Deletion time. format google-datetime readOnly True type string deprecationMessage description Deprecation message. This will appear alongside any warnings to update. This string is already escaped and is safe to use. type string extensionRoot description Root directory of this Extension in the repository at this version. type string hash description Output only. SHA256 hash of the archive. readOnly True type string icons description Output only. Icons for the extension version items $ref GoogleFirebaseExtensionsV1betaIcon readOnly True type array id description Output only. Version number. readOnly True type string listing $ref GoogleFirebaseExtensionsV1betaExtensionVersionListing readOnly True metrics $ref GoogleFirebaseExtensionsV1betaExtensionVersionMetrics description Output only. Metrics of the Extension, such as active install count readOnly True name description Output only. Fully qualified name of ExtensionVersion (e.g. publishers/publisher-id/extensions/awesome-extension/versions/0.2.1) readOnly True type string ref description Output only. User-friendly identifier for the ExtensionVersion (e.g. publisher-id/awesome-extension@1.2.3) readOnly True type string releaseNotes description Output only. Markdown release notes describing what changed in this release. readOnly True type string sourceDownloadUri description Output only. URI where the underlying source code for this extension can be downloaded. readOnly True type string spec $ref GoogleFirebaseExtensionsV1betaExtensionSpec description Output only. Parsed spec from extension.yaml. readOnly True state description Output only. State of the ExtensionVersion. enum STATE_UNSPECIFIED PUBLISHED DEPRECATED enumDescriptions Default state. Generally not used. Can be installed by consumers. Can be reconfigured but not freshly installed by consumers. readOnly True type string tags description Output only. A list of extension tags items type string readOnly True type array type object GoogleFirebaseExtensionsV1betaExtensionVersionListing id GoogleFirebaseExtensionsV1betaExtensionVersionListing properties state description The state of the listing request for this ExtensionVersion. enum STATE_UNSPECIFIED UNLISTED PENDING REJECTED APPROVED enumDescriptions Unspecified. Do not use. No requests to be listed. Listing has been requested, pending a result. Rejected, will not be listed on the Extensions Marketplace. Approved, will be listed on the Extensions Marketplace. type string type object GoogleFirebaseExtensionsV1betaExtensionVersionMetrics description ExtensionVersionMetrics stores metrics for each extension version, like per-version active install count id GoogleFirebaseExtensionsV1betaExtensionVersionMetrics properties activeInstallCount description The approximate count of active installs. format int64 type string type object GoogleFirebaseExtensionsV1betaExternalService description Representation of an external service that is used by this Extension. id GoogleFirebaseExtensionsV1betaExternalService properties name description Required. Name of the external service. type string pricingUri description Required. Link to the pricing page for the external service. type string type object GoogleFirebaseExtensionsV1betaFatalRuntimeError description An error message for a fatal error state set by the extension developer. id GoogleFirebaseExtensionsV1betaFatalRuntimeError properties errorMessage description The error message. This is set by the extension developer to give more detail on why the extension is unusable and must be re-installed or reconfigured. type string type object GoogleFirebaseExtensionsV1betaIcon description An icon for the extension version id GoogleFirebaseExtensionsV1betaIcon properties iconType description The icon type enum ICON_TYPE_UNSPECIFIED SVG PNG_240 PNG_512 enumDescriptions Unspecified icon. Do not use. An SVG icon Legacy - the original PNG icon size (120@2x) A PNG icon that is 512 x 512px type string iconUri description Uri of the icon. e.g. a g-static or Cloud Storage URL type string type object GoogleFirebaseExtensionsV1betaLifecycleEvent description A Lifecycle Event that allows the extension developer to specify a function that should run at a particular lifecycle stage. id GoogleFirebaseExtensionsV1betaLifecycleEvent properties processingMessage description Optional. If present the lifecycle event will also set the status of the extension to PROCESSING with the included message. Max length of 250 chars. type string stage description The stage to run the callee at. enum STAGE_UNSPECIFIED ON_INSTALL ON_UPDATE ON_CONFIGURE enumDescriptions The stage is unspecified. Do Not Use. The callee should be run after install. The callee should be run after update. The callee should be run after configure. type string taskQueueTriggerFunction description A taskQueueTrigger function that should run at the specified stage. This must be the name of a taskQueueTrigger function defined in the resources section. type string type object GoogleFirebaseExtensionsV1betaListExtensionInstancesResponse description Used to list Extension instances. id GoogleFirebaseExtensionsV1betaListExtensionInstancesResponse properties instances description The list of Extension Instances in this project. items $ref GoogleFirebaseExtensionsV1betaExtensionInstance type array nextPageToken description Pagination token, if more results exist. type string type object GoogleFirebaseExtensionsV1betaListExtensionVersionsResponse description Used to list ExtensionVersions. id GoogleFirebaseExtensionsV1betaListExtensionVersionsResponse properties extensionVersions description The list of ExtensionVersions for this Extension. items $ref GoogleFirebaseExtensionsV1betaExtensionVersion type array nextPageToken description Pagination token, if more results exist. type string type object GoogleFirebaseExtensionsV1betaListExtensionsResponse description Used to list Extensions. id GoogleFirebaseExtensionsV1betaListExtensionsResponse properties extensions description The list of Extensions in this project. items $ref GoogleFirebaseExtensionsV1betaExtension type array nextPageToken description Pagination token, if more results exist. type string type object GoogleFirebaseExtensionsV1betaParamSelectOption description Representation of an option that the user can select for a param, if the param type is select or multiselect. id GoogleFirebaseExtensionsV1betaParamSelectOption properties label description Optional. User-friendly description of option. If omitted, defaults to value. type string value description Required. Value of option. type string type object GoogleFirebaseExtensionsV1betaPublishExtensionVersionRequest description Used to publish an ExtensionVersion. id GoogleFirebaseExtensionsV1betaPublishExtensionVersionRequest properties extensionRoot description Optional. The directory location of extension.yaml in the archived package. If none is specified, then the package root is assumed ("/"). type string packageUri description Optional. Public URI of a zip or tarball of the extension source code type string repoUri description Optional. URI of the Extension's public Git repository. Format must be https://// (e.g. https://github.com/firebase/extensions). Required only for the first version of the Extension. Cannot be changed. type string sourceRef description Optional. Commit hash, branch, or tag to build from the Extension's repo. type string versionId description Required. Version to publish. e.g. 1.2.3 type string type object GoogleFirebaseExtensionsV1betaPublisherProfile description A PublisherProfile is a singleton resource for a Project. It represents the publisher metadata. Since the project-number is considered pii, this proto is not meant for public consumption. id GoogleFirebaseExtensionsV1betaPublisherProfile properties displayName description Required. Public human-readable name for the publisher. type string iconUri description Optional. URI of the publisher's icon type string name description Output only. Name for the PublisherProfile (e.g. projects/283847228472/publisherProfile) readOnly True type string publisherId description Immutable. Unique user-friendly ID of publisher (e.g. firebase) type string registerTime description Output only. Register time. format google-datetime readOnly True type string websiteUri description Optional. Website associated with the publisher. type string type object GoogleFirebaseExtensionsV1betaPublisherSummary description A public-facing summary of a publisher. Not to be confused with "PublisherProfile", which is used for publisher facing APIs. It's also not intended to be used as an independent resource. id GoogleFirebaseExtensionsV1betaPublisherSummary properties displayName description Display name of the publisher. type string iconUri description Uri of the publisher's icon. type string type object GoogleFirebaseExtensionsV1betaResource description Representation of a Resource that will be created for an Extension. id GoogleFirebaseExtensionsV1betaResource properties deletionPolicy description Enum representing whether the resource should get deleted or abandoned (left behind) when the Extension is uninstalled. Not yet used. enum DELETION_POLICY_UNSPECIFIED DELETE ABANDON enumDescriptions The default policy - delete the resource when Extension is uninstalled. Abandon the resource when Extension is uninstalled. type string description description Optional. Description of the Resource. type string name description Required. Name of the Resource. type string properties additionalProperties additionalProperties description Properties of the object. Contains field @type with type URL. type any type object description Required. Properties of the Resource. The values here will be representative of the properties available for each resource type (see `type`). For example, a [Pub/Sub Topic (`pubsub.v1.topic`)](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics) can accept `labels` as a property; `properties` of a Topic could include ```{ "labels": { "some_key": "some_value" } }``` type object propertiesYaml description Output only. A YAML string representing the properties of the resource. readOnly True type string type description Required. Type of the Resource. This can be any valid [Deployment Manager type](https://cloud.google.com/deployment-manager/docs/configuration/supported-resource-types) or Extension-specific `firebaseextensions.v1beta.function`. type string type object GoogleFirebaseExtensionsV1betaResourceInfo description Representation of additional resource information for parameters of type RESOURCE. id GoogleFirebaseExtensionsV1betaResourceInfo properties resourceType description Required. Type of resource, e.g. storage.googleapis.com/Bucket type string type object GoogleFirebaseExtensionsV1betaRole description Representation of a Firebase IAM Role or a Cloud IAM role that is required by this Extension. id GoogleFirebaseExtensionsV1betaRole properties reason description Optional. Reason the role is needs to be enabled. type string resource description Optional. Resource the role should be granted on. Defaults to the project. type string role description Required. Name of role. type string type object GoogleFirebaseExtensionsV1betaRuntimeData description The singleton runtime data for the extension instance. id GoogleFirebaseExtensionsV1betaRuntimeData properties fatalError $ref GoogleFirebaseExtensionsV1betaFatalRuntimeError description The fatal error state to set for the extension instance name description The name of the Extension Instance Runtime Data resource. type string processingState $ref GoogleFirebaseExtensionsV1betaRuntimeProcessingState description The processing state to set for the extension instance stateUpdateTime description Output only. The time of the last state update. format google-datetime readOnly True type string type object GoogleFirebaseExtensionsV1betaRuntimeProcessingState description The processing state for the extension instance runtime data. id GoogleFirebaseExtensionsV1betaRuntimeProcessingState properties detailMessage description Details about the processing. e.g. This could include the type of processing in progress or it could list errors or failures. This information will be shown in the console on the detail page for the extension instance. type string state description The processing state of the extension instance. enum STATE_UNSPECIFIED NONE PROCESSING PROCESSING_COMPLETE PROCESSING_WARNING PROCESSING_FAILED enumDescriptions The default state. Do not use. Can be used to explicitly clear a previous processing state. Processing in progress. This indicates that an important process is running. This should only be set for infrequent processes that run in the background and should not be used for frequent processing. Processing completed successfully Processing completed but some non-critical errors occurred during the processing. Processing failed, but the extension is still usable. type string type object GoogleFirebaseExtensionsV1betaUndeprecateExtensionVersionRequest description Used to un-deprecate an ExtensionVersion. id GoogleFirebaseExtensionsV1betaUndeprecateExtensionVersionRequest properties type object GoogleFirebaseExtensionsV1betaUnpublishExtensionRequest description Used to unpublish an Extension. id GoogleFirebaseExtensionsV1betaUnpublishExtensionRequest properties type object GoogleFirebaseExtensionsV1betaUnpublishExtensionVersionRequest description Used to unpublish an ExtensionVersion. id GoogleFirebaseExtensionsV1betaUnpublishExtensionVersionRequest properties type object GoogleIamV1AuditConfig description Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. id GoogleIamV1AuditConfig properties auditLogConfigs description The configuration for logging of each type of permission. items $ref GoogleIamV1AuditLogConfig type array service description Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. type string type object GoogleIamV1AuditLogConfig description Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. id GoogleIamV1AuditLogConfig properties exemptedMembers description Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. items type string type array logType description The 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 type string type object GoogleIamV1Binding description Associates `members`, or principals, with a `role`. id GoogleIamV1Binding properties condition $ref GoogleTypeExpr description The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). members description Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. items type string type array role description Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). type string type object GoogleIamV1GetIamPolicyRequest description Request message for `GetIamPolicy` method. id GoogleIamV1GetIamPolicyRequest properties options $ref GoogleIamV1GetPolicyOptions description OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. type object GoogleIamV1GetPolicyOptions description Encapsulates settings provided to GetIamPolicy. id GoogleIamV1GetPolicyOptions properties requestedPolicyVersion description Optional. 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). format int32 type integer type object GoogleIamV1Policy description An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). id GoogleIamV1Policy properties auditConfigs description Specifies cloud audit logging configuration for this policy. items $ref GoogleIamV1AuditConfig type array bindings description Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. items $ref GoogleIamV1Binding type array 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. format byte type string version description Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). format int32 type integer type object GoogleIamV1SetIamPolicyRequest description Request message for `SetIamPolicy` method. id GoogleIamV1SetIamPolicyRequest properties policy $ref GoogleIamV1Policy description REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. updateMask description OPTIONAL: 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"` format google-fieldmask type string type object GoogleIamV1TestIamPermissionsRequest description Request message for `TestIamPermissions` method. id GoogleIamV1TestIamPermissionsRequest properties permissions description The 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 type string type array type object GoogleIamV1TestIamPermissionsResponse description Response message for `TestIamPermissions` method. id GoogleIamV1TestIamPermissionsResponse properties permissions description A subset of `TestPermissionsRequest.permissions` that the caller is allowed. items type string type array type object GoogleLongrunningOperation description This resource represents a long-running operation that is the result of a network API call. id GoogleLongrunningOperation properties done description If 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. type boolean error $ref GoogleRpcStatus description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object GoogleProtobufEmpty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id GoogleProtobufEmpty properties type object GoogleRpcStatus description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id GoogleRpcStatus properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object GoogleTypeExpr description Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. id GoogleTypeExpr properties description description Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. type string expression description Textual representation of an expression in Common Expression Language syntax. type string location description Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. type string title description Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. type string type object servicePath title Firebase Extensions API version v1beta version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/firebaseextensions-v1beta	values_changed root['revision'] new_value 20250205 old_value 20250202
prod/firebaseextensionspublisher-	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/cloud-platform.read-only description View your data across Google Cloud services and see the email address of your Google Account https://www.googleapis.com/auth/firebase description View and administer all your Firebase data and settings https://www.googleapis.com/auth/firebase.readonly description View all your Firebase data and settings basePath baseUrl https://firebaseextensionspublisher.googleapis.com/ batchPath batch canonicalName Firebase Extensions Publisher description firebaseextensionspublisher.googleapis.com API. discoveryVersion v1 documentationLink https://firebase.google.com/products/extensions fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id firebaseextensionspublisher:v1beta kind discovery#restDescription mtlsRootUrl https://firebaseextensionspublisher.mtls.googleapis.com/ name firebaseextensionspublisher ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects methods getPublisherProfile description Gets a PublisherProfile for a Project. flatPath v1beta/projects/{projectsId}/publisherProfile httpMethod GET id firebaseextensionspublisher.projects.getPublisherProfile parameterOrder name parameters name description Required. The name of the PublisherProfile. e.g. `projects/23427309/publisherProfile` or `projects/project-id/publisherProfile` location path pattern ^projects/[^/]+/publisherProfile$ required True type string publisherId description Pass “-” for project ID with this query param, to lookup publisher project using the publisher ID. location query type string path v1beta/{+name} response $ref PublisherProfile scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly updatePublisherProfile description Updates a PublisherProfile for a Project. flatPath v1beta/projects/{projectsId}/publisherProfile httpMethod PATCH id firebaseextensionspublisher.projects.updatePublisherProfile parameterOrder name parameters name description Output only. Name for the PublisherProfile (e.g. projects/283847228472/publisherProfile) location path pattern ^projects/[^/]+/publisherProfile$ required True type string updateMask description Field mask to support partial updates. format google-fieldmask location query type string validateOnly description Optional. If set to true, the request is validated, but no actual change is made location query type boolean path v1beta/{+name} request $ref PublisherProfile response $ref PublisherProfile scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase resources operations methods get description Gets an Operation. flatPath v1beta/projects/{projectsId}/operations/{operationsId} httpMethod GET id firebaseextensionspublisher.projects.operations.get parameterOrder name parameters name description Required. The name of the long running Operation. e.g. `projects/{project_id}/operations/{operation_id}` location path pattern ^projects/[^/]+/operations/[^/]+$ required True type string path v1beta/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly publishers resources extensions methods get description Gets an Extension. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId} httpMethod GET id firebaseextensionspublisher.publishers.extensions.get parameterOrder name parameters name description Required. The name of the Extension. e.g. `publishers/publisher-id/extensions/extension-id` location path pattern ^publishers/[^/]+/extensions/[^/]+$ required True type string path v1beta/{+name} response $ref Extension scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly list description Lists all Extensions for a Publisher. flatPath v1beta/publishers/{publishersId}/extensions httpMethod GET id firebaseextensionspublisher.publishers.extensions.list parameterOrder parent parameters pageSize description The number of results to return. Defaults to 50. format int32 location query type integer pageToken description Pagination token from a previous request. location query type string parent description Required. The Publisher which we are listing Extensions for. e.g. `publishers/publisher-id`. location path pattern ^publishers/[^/]+$ required True type string path v1beta/{+parent}/extensions response $ref ListExtensionsResponse scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly resources versions methods createFromSource description Creates an ExtensionVersion from source. This is a non-standard CREATE method. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions:createFromSource httpMethod POST id firebaseextensionspublisher.publishers.extensions.versions.createFromSource parameterOrder parent parameters parent description Required. The Publisher and Extension for the ExtensionVersion. e.g. `publishers/publisher-id/extensions/extension-id` location path pattern ^publishers/[^/]+/extensions/[^/]+$ required True type string path v1beta/{+parent}/versions:createFromSource request $ref CreateExtensionVersionFromSourceRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase delete description Deletes an ExtensionVersion. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions/{versionsId} httpMethod DELETE id firebaseextensionspublisher.publishers.extensions.versions.delete parameterOrder name parameters name description Required. The name of the ExtensionVersion we want to delete. e.g. `publishers/publisher-id/extensions/extension-id/versions/1.2.3` location path pattern ^publishers/[^/]+/extensions/[^/]+/versions/[^/]+$ required True type string path v1beta/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase deprecate description Deprecates an ExtensionVersion. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions/{versionsId}:deprecate httpMethod POST id firebaseextensionspublisher.publishers.extensions.versions.deprecate parameterOrder name parameters name description Required. The name of the ExtensionVersion we want to deprecate. e.g. `publishers/publisher-id/extensions/extension-id/versions/1.2.3` location path pattern ^publishers/[^/]+/extensions/[^/]+/versions/[^/]+$ required True type string path v1beta/{+name}:deprecate request $ref DeprecateExtensionVersionRequest response $ref ExtensionVersion scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase get description Gets an ExtensionVersion. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions/{versionsId} httpMethod GET id firebaseextensionspublisher.publishers.extensions.versions.get parameterOrder name parameters name description Required. The name of the ExtensionVersion. e.g. `publishers/publisher-id/extensions/extension-id/versions/1.2.3` or `publishers/publisher-id/extensions/extension-id/versions/latest` location path pattern ^publishers/[^/]+/extensions/[^/]+/versions/[^/]+$ required True type string path v1beta/{+name} response $ref ExtensionVersion scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly list description Lists all ExtensionVersions for an Extension. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions httpMethod GET id firebaseextensionspublisher.publishers.extensions.versions.list parameterOrder parent parameters filter description Filter which versions of this extension are returned, per https://google.aip.dev/160. Uses EBNF grammar https://google.aip.dev/assets/misc/ebnf-filtering.txt. location query type string pageSize description The number of results to return. Defaults to 50. format int32 location query type integer pageToken description Pagination token from a previous request. location query type string parent description Required. The name of the Extenson that we are listing ExtensionVersions for for. e.g. `publishers/publisher_id/extensions/extension_id` location path pattern ^publishers/[^/]+/extensions/[^/]+$ required True type string showPrereleases description Include pre-release ExtensionVersions. location query type boolean path v1beta/{+parent}/versions response $ref ListExtensionVersionsResponse scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/firebase.readonly requestListing description Requests that an ExtensionVersion be listed on the Extensions Marketplace. Triggers an async review workflow. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions/{versionsId}:requestListing httpMethod POST id firebaseextensionspublisher.publishers.extensions.versions.requestListing parameterOrder name parameters name description Required. The name of the ExtensionVersion. e.g. `publishers/publisher-id/extensions/extension-id/versions/1.2.3` or `publishers/publisher-id/extensions/extension-id/versions/latest` location path pattern ^publishers/[^/]+/extensions/[^/]+/versions/[^/]+$ required True type string path v1beta/{+name}:requestListing request $ref RequestListingRequest response $ref ExtensionVersion scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase undeprecate description Un-deprecates an ExtensionVersion. flatPath v1beta/publishers/{publishersId}/extensions/{extensionsId}/versions/{versionsId}:undeprecate httpMethod POST id firebaseextensionspublisher.publishers.extensions.versions.undeprecate parameterOrder name parameters name description Required. The name of the ExtensionVersion we want to un-deprecate. e.g. `publishers/publisher-id/extensions/extension-id/versions/1.2.3` location path pattern ^publishers/[^/]+/extensions/[^/]+/versions/[^/]+$ required True type string path v1beta/{+name}:undeprecate request $ref UndeprecateExtensionVersionRequest response $ref ExtensionVersion scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/firebase revision 20250205 rootUrl https://firebaseextensionspublisher.googleapis.com/ schemas Api description Representation of a Google API that is used by this Extension. id Api properties apiName description Required. Name of API. type string reason description Optional. Reason the API needs to be enabled. type string type object Author description Representation of contact information associated with a human being or organization. Used to represent the author or creator of the Extension. id Author properties authorName description Required. Name of the author. type string email description Optional. Public email of the author. type string url description Optional. URL for GitHub, Twitter, or website associated with the author. type string type object CreateExtensionVersionFromSourceRequest description Used to create an ExtensionVersion from source. This is a non-standard CREATE request message. id CreateExtensionVersionFromSourceRequest properties extensionRoot description Optional. The directory location of extension.yaml in the source code. If none is specified, then the root is assumed ("/"). type string githubRepositorySource $ref GitHubRepository description Source is a GitHub repository. remoteArchiveSource $ref RemoteArchive description Source is an archive stored remotely. versionId description Required. Version to publish. e.g. 1.2.3 type string type object DeprecateExtensionVersionRequest description Used to deprecate an ExtensionVersion. id DeprecateExtensionVersionRequest properties deprecationMessage description Deprecation message. This will appear alongside any warnings to update. type string type object Empty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id Empty properties type object EventDescriptor description EventDescriptor contains the minimum information to describe a CloudEvent. id EventDescriptor properties description description Required. Description of the event. type string type description Required. The type of the event. Should follow CloudEvent schema requirements for "type" field. https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type type string type object Extension description An `Extension` is a published extension, for sharing with other users. id Extension properties createTime description Output only. Creation time. format google-datetime readOnly True type string deleteTime description Output only. Deletion time. format google-datetime readOnly True type string iconUri description Output only. Uri of the extension’s icon. e.g. a g-static or Cloud Storage URL readOnly True type string latestApprovedVersion description Output only. ID of the latest approved ExtensionVersion that corresponds to this Extension, according to semver versioning (e.g. 0.3.3). readOnly True type string latestVersion description Output only. ID of the latest verifiable stable ExtensionVersion that corresponds to this Extension, according to semver versioning (e.g. 0.3.3). readOnly True type string latestVersionCreateTime description Output only. Time of when the latest ExtensionVersion was created. format google-datetime readOnly True type string metrics $ref ExtensionMetrics description Output only. Metrics of the Extension, such as active install count readOnly True name description Output only. Fully qualified name of Extension (e.g. publishers/publisher-id/extensions/awesome-extension) readOnly True type string publisher $ref PublisherSummary description Publisher detail about the extension author. ref description Output only. User-friendly identifier for the Extension (e.g. publisher-id/awesome-extension) readOnly True type string repoUri description Output only. URI of the Extension's public Git repository. readOnly True type string state description Output only. State of the extension. enum STATE_UNSPECIFIED PUBLISHED DEPRECATED SUSPENDED enumDescriptions Default state. Generally not used. Can be installed by consumers. Cannot be installed by consumers. Automatically set when all versions have been deprecated. Returns to PUBLISHED state when a new version is published. The extension is hidden from consumers, cannot be installed or reconfigured. Existing users of the extensions will be prompted to uninstall the extension. readOnly True type string suspensionDetails $ref SuspensionDetails description Output only. Suspension status of the extension. Empty when not suspended. When extension is suspended, the extension and its versions are not visible to app developers. readOnly True tags description Output only. A list of extension tags from the latest approved version items type string readOnly True type array type object ExtensionMetrics description ExtensionMetrics contains metrics for Extensions, such as aggregated active instance count id ExtensionMetrics properties activeInstallCount description The approximate count of active installs of all versions. format int64 type string type object ExtensionSpec description The specification of an Extension. id ExtensionSpec properties apis description Optional. List of Google APIs that will be enabled on a project as part of the install process of this Extension. items $ref Api type array author $ref Author description Optional. Primary author of the Extension and point of contact for Extension information. billingRequired description Optional. Indicator if an associated billing account is needed to use this Extension. Defaults to false. type boolean contributors description Optional. Multiple authors of the Extension. Used to give credit to other contributors to the Extension beyond the author. items $ref Author type array description description Optional. Description of the Extension. type string displayName description Optional. Human-readable name of the Extension (e.g. "Image Resizer"). type string events description Optional. A list of descriptors describing what events are emitted by this extension. items $ref EventDescriptor type array externalServices description Optional. List of external services this extension uses. items $ref ExternalService type array icon description Optional. Icon filename. e.g. icon.png The icon must be present in the same directory as the extension.yaml file. The icon must be square. The icon must be PNG. The icon must be between 512 - 1024 pixels per side. We recommend icons exactly 512x512. Larger icons will be automatically resized to 512x512. Icon is not a required field. If no icon is specified, a default icon will be shown instead. type string license description Optional. License information for the Extension. Should follow SPDX format. See: https://spdx.org/licenses/ type string lifecycleEvents description Optional. A List of things to execute at certain lifecycle stages. items $ref LifecycleEvent type array name description Required. Name of the Extension. This is an identifier the publisher chooses when publishing this extension onto the registry, and is part of the extension ref. (e.g. "storage_resize_images") type string params description Optional. List of environment variables that may be configured for the Extension. items $ref ExtensionSpecParameter type array postinstallContent description Output only. Any postinstall instructions to be shown for this Extension. readOnly True type string preinstallContent description Output only. Any preinstall instructions to be shown for this Extension. readOnly True type string readmeContent description Output only. Any README content to be shown for this Extension. readOnly True type string releaseNotesUrl description Optional. URL of where the release notes can be found. type string resources description Required. List of Resources that will be created in installation. items $ref Resource type array roles description Optional. List of IAM roles that define the access the Extension will have in the project. items $ref Role type array sourceUrl description Optional. URL where the source code of the Extension can be found. type string specVersion description Required. Version of the Extension Specification used. type string systemParams description Output only. Params whose values are only available at deployment time. Unlike other params, these will not be set as environment variables on functions. items $ref ExtensionSpecParameter readOnly True type array tags description Output only. A list of extension tags items type string readOnly True type array version description Required. Version of the Extension. type string type object ExtensionSpecParameter description Representation of a configurable parameter for an Extension. These can be used to configure resources or referenced as environment variables in a Cloud Function. id ExtensionSpecParameter properties advanced description Optional. Whether a param is meant for all users, or just advanced users. Advanced params are displayed separately and are hidden at first. type boolean default description Optional. Default value if an Extension consumer leaves the parameter value blank. type string description description Optional. Additional description for the parameter. It will be shown to the Extension consumer when they are prompted for the parameter value. Markdown is supported. type string example description Optional. Example of what this value might look like. type string immutable description Optional. Whether or not the user should be prevented from updating the value of this parameter later. Defaults to false. type boolean label description Required. Label for the parameter, shown to the Extension consumer when they are prompted for the parameter value. type string options description Optional. A list of values that the consumer can pick from, if the param.Type is select or multiSelect items $ref ParamSelectOption type array param description Required. Name of the parameter. type string required description Optional. Flag indicating if the parameter must be defined and not empty. Defaults to false. type boolean resourceInfo $ref ResourceInfo description Optional. Additional resource information which must be specified when parameter type is RESOURCE. type description Optional. Type of input. If unspecified, it is assumed to be STRING. enum EXTENSION_SPEC_PARAMETER_TYPE_UNSPECIFIED STRING SELECT MULTISELECT SELECT_RESOURCE SECRET enumDescriptions Unspecified. Unused. Param is a free-form string input. Param allows selecting one option to be its value. Param allows selecting multiple options. Param allows specifying some external resource, ex. Cloud Storage bucket. Param represents a Cloud Secret Manager Secret. type string validationErrorMessage description Optional. Error message to display if regex validation fails. type string validationRegex description Optional. Regex string for validation of the parameter value provided by the Extension consumer. type string type object ExtensionVersion description An ExtensionVersion is a published version of an Extension, for sharing with other users. id ExtensionVersion properties buildSourceUri description Output only. Git commit URI (e.g. github.com///tree/) that this ExtensionVersion was built from. Empty if not a verifiable version. readOnly True type string createTime description Output only. Time of creation. format google-datetime readOnly True type string deleteTime description Output only. Deletion time. format google-datetime readOnly True type string deprecationMessage description Deprecation message. This will appear alongside any warnings to update. This string is already escaped and is safe to use. type string extensionRoot description Root directory of this Extension in the repository at this version. type string hash description Output only. SHA256 hash of the archive. readOnly True type string icons description Output only. Icons for the extension version items $ref Icon readOnly True type array id description Output only. Version number. readOnly True type string listing $ref Listing description Output only. Listing describes whether an extension version is listed on extensions.dev readOnly True metrics $ref ExtensionVersionMetrics description Output only. Metrics of the Extension, such as active install count readOnly True name description Output only. Fully qualified name of ExtensionVersion (e.g. publishers/publisher-id/extensions/awesome-extension/versions/0.2.1) readOnly True type string ref description Output only. User-friendly identifier for the ExtensionVersion (e.g. publisher-id/awesome-extension@1.2.3) readOnly True type string releaseNotes description Output only. Markdown release notes describing what changed in this release. readOnly True type string sourceDownloadUri description Output only. URI where the underlying source code for this extension can be downloaded. readOnly True type string spec $ref ExtensionSpec description Output only. Parsed spec from extension.yaml. readOnly True state description Output only. State of the ExtensionVersion. enum STATE_UNSPECIFIED PUBLISHED DEPRECATED enumDescriptions Default state. Generally not used. Can be installed by consumers. Can be reconfigured but not freshly installed by consumers. readOnly True type string tags description Output only. A list of extension tags items type string readOnly True type array type object ExtensionVersionMetrics description ExtensionVersionMetrics stores metrics for each extension version, like per-version active install count id ExtensionVersionMetrics properties activeInstallCount description The approximate count of active installs. format int64 type string type object ExternalService description Representation of an external service that is used by this Extension. id ExternalService properties name description Required. Name of the external service. type string pricingUri description Required. Link to the pricing page for the external service. type string type object Feedback description Feedback on a request to list an ExtensionVersion on the Extensions Marketplace. id Feedback properties createTime description Timestamp of when feedback was given. format google-datetime type string message description Reasons provided by manual or automated reviews to explain the result. type string type object GitHubRepository description Source is a GitHub repository. id GitHubRepository properties sourceRef description Required. Commit hash, branch, or tag to build from the Extension's repo. type string uri description Optional. URI of the Extension's public GitHub repository. Format must be https://github.com// (e.g. https://github.com/firebase/extensions). Required only for the first version of the Extension. type string type object Icon description An icon for the extension version id Icon properties iconType description The icon type enum ICON_TYPE_UNSPECIFIED SVG PNG_240 PNG_512 enumDescriptions Unspecified icon. Do not use. An SVG icon Legacy - the original PNG icon size (120@2x) A PNG icon that is 512 x 512px type string iconUri description Uri of the icon. e.g. a g-static or Cloud Storage URL type string type object LifecycleEvent description A Lifecycle Event that allows the extension developer to specify a function that should run at a particular lifecycle stage. id LifecycleEvent properties processingMessage description Optional. If present the lifecycle event will also set the status of the extension to PROCESSING with the included message. Max length of 250 chars. type string stage description Optional. The stage to run the callee at. enum STAGE_UNSPECIFIED ON_INSTALL ON_UPDATE ON_CONFIGURE enumDescriptions The stage is unspecified. Do Not Use. The callee should be run after install. The callee should be run after update. The callee should be run after configure. type string taskQueueTriggerFunction description A taskQueueTrigger function that should run at the specified stage. This must be the name of a taskQueueTrigger function defined in the resources section. type string type object ListExtensionVersionsResponse description Used to list ExtensionVersions. id ListExtensionVersionsResponse properties extensionVersions description The list of ExtensionVersions for this Extension. items $ref ExtensionVersion type array nextPageToken description Pagination token, if more results exist. type string type object ListExtensionsResponse description Used to list Extensions. id ListExtensionsResponse properties extensions description The list of Extensions in this project. items $ref Extension type array nextPageToken description Pagination token, if more results exist. type string type object Listing description Listing describes whether an extension version is listed on extensions.dev id Listing properties feedback description Feedback from manual and automated reviews to explain the state. items $ref Feedback type array listingRequestTime description Timestamp of when listing was requested format google-datetime type string state description The state of the listing request for this ExtensionVersion. enum STATE_UNSPECIFIED UNLISTED PENDING REJECTED APPROVED enumDescriptions Unspecified. Do not use. No requests to be listed. Listing has been requested, pending a result. Rejected, will not be listed on the Extensions Marketplace. Approved, will be listed on the Extensions Marketplace. type string type object Operation description This resource represents a long-running operation that is the result of a network API call. id Operation properties done description If 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. type boolean error $ref Status description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object ParamSelectOption description Representation of an option that the user can select for a param, if the param type is select or multiselect. id ParamSelectOption properties label description Optional. User-friendly description of option. If omitted, defaults to value. type string value description Required. Value of option. type string type object PublisherProfile description A PublisherProfile is a singleton resource for a Project. It represents the publisher metadata. Since the project-number is considered pii, this proto is not meant for public consumption. id PublisherProfile properties displayName description Required. Public human-readable name for the publisher. type string iconUri description Optional. URI of the publisher's icon type string name description Output only. Name for the PublisherProfile (e.g. projects/283847228472/publisherProfile) readOnly True type string publisherId description Immutable. Unique user-friendly ID of publisher (e.g. firebase) type string registerTime description Output only. Register time. format google-datetime readOnly True type string state description Output only. State of the publisher profile. enum STATE_UNSPECIFIED ACTIVE SUSPENDED enumDescriptions Default state. Generally not used. Active publisher profile. The publisher profile and all its extensions are hidden from consumers, extensions cannot be installed or reconfigured. Existing users of this publisher's extensions will be prompted to uninstall them. readOnly True type string suspensionDetails $ref SuspensionDetails description Output only. Suspension details of the profile. Empty when not suspended. When publisher profile is suspended, the profile and all its extensions and their versions are not visible to app developers. readOnly True websiteUri description Optional. Website associated with the publisher. type string type object PublisherSummary description A public-facing summary of a publisher. Not to be confused with "PublisherProfile", which is used for publisher facing APIs. It's also not intended to be used as an independent resource. id PublisherSummary properties displayName description Display name of the publisher. type string iconUri description Uri of the publisher's icon. type string type object RemoteArchive description Source is an archive stored remotely. id RemoteArchive properties packageUri description Required. Public URI of a zip or tarball of the extension source code. type string type object RequestListingRequest description Used to list an ExtensionVersion on the Extensions Marketplace. id RequestListingRequest properties type object Resource description Representation of a Resource that will be created for an Extension. id Resource properties deletionPolicy description Optional. Enum representing whether the resource should get deleted or abandoned (left behind) when the Extension is uninstalled. Not yet used. enum DELETION_POLICY_UNSPECIFIED DELETE ABANDON enumDescriptions Unspecified. Not used. The default policy - delete the resource when Extension is uninstalled. Abandon the resource when Extension is uninstalled. type string description description Optional. Description of the Resource. type string name description Required. Name of the Resource. type string properties additionalProperties additionalProperties description Properties of the object. Contains field @type with type URL. type any type object description Required. Properties of the Resource. The values here will be representative of the properties available for each resource type (see `type`). For example, a [Pub/Sub Topic (`pubsub.v1.topic`)](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics) can accept `labels` as a property; `properties` of a Topic could include ```{ "labels": { "some_key": "some_value" } }``` type object propertiesYaml description Output only. A YAML string representing the properties of the resource. readOnly True type string type description Required. Type of the Resource. This can be any valid [Deployment Manager type](https://cloud.google.com/deployment-manager/docs/configuration/supported-resource-types) or Extension-specific `firebaseextensions.v1beta.function`. type string type object ResourceInfo description Representation of additional resource information for parameters of type RESOURCE. id ResourceInfo properties resourceType description Required. Type of resource, e.g. storage.googleapis.com/Bucket type string type object Role description Representation of a Firebase IAM Role or a Cloud IAM role that is required by this Extension. id Role properties reason description Optional. Reason the role is needs to be enabled. type string resource description Optional. Resource the role should be granted on. Defaults to the project. type string role description Required. Name of role. type string type object Status description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id Status properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object SuspensionDetails description Entity (ex. publisher profile, extension, version) suspension details. id SuspensionDetails properties updateTime description Timestamp when the suspension state last changed. format google-datetime type string type object UndeprecateExtensionVersionRequest description Used to un-deprecate an ExtensionVersion. id UndeprecateExtensionVersionRequest properties type object servicePath title Firebase Extensions Publisher API version v1beta version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/firebaseextensionspublisher-v1beta	values_changed root['revision'] new_value 20250205 old_value 20250202
prod/firebasehosting-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebasehosting-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebasehosting-v1beta1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebaseinstallations-v1	values_changed root new_value basePath baseUrl https://firebaseinstallations.googleapis.com/ batchPath batch canonicalName Firebaseinstallations description discoveryVersion v1 documentationLink https://firebase.google.com fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id firebaseinstallations:v1 kind discovery#restDescription mtlsRootUrl https://firebaseinstallations.mtls.googleapis.com/ name firebaseinstallations ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources installations methods create description Creates (and registers) a new Firebase Installation, incl. its FID and associated keys/tokens for authentication: - For FIS_v1, this associates the client-side generated Verification Key with the Firebase Installation. - For FIS_v2, this creates the Refresh Token which is used to authenticate GenerateAuthToken requests. - This also creates the initial temporary FIS-Auth-Token. Refer to https://cloud.google.com/apis/design/standard_methods for method definition formats. flatPath v1/projects/{projectsId}/installations httpMethod POST id firebaseinstallations.projects.installations.create parameterOrder parent parameters parent description The parent resource name. Identifies the Cloud Project owning this Installation. We accept both projectID and projectNumber. location path pattern ^projects/[^/]+$ required True type string path v1/{+parent}/installations request $ref GoogleFirebaseInstallationsV1Installation response $ref GoogleFirebaseInstallationsV1Installation delete description Deletes an Installation flatPath v1/projects/{projectsId}/installations/{installationsId} httpMethod DELETE id firebaseinstallations.projects.installations.delete parameterOrder name parameters name description Resource name of the installation. It must have the format of `projects/*/installations/*`. location path pattern ^projects/[^/]+/installations/[^/]+$ required True type string path v1/{+name} response $ref GoogleProtobufEmpty resources authTokens methods generate description Creates a new temporary FIS-Auth-Token (Bearer-Token for Installations). flatPath v1/projects/{projectsId}/installations/{installationsId}/authTokens:generate httpMethod POST id firebaseinstallations.projects.installations.authTokens.generate parameterOrder name parameters name description The Firebase Installation requesting for FIS-Auth-Token. location path pattern ^projects/[^/]+/installations/[^/]+$ required True type string path v1/{+name}/authTokens:generate request $ref GoogleFirebaseInstallationsV1GenerateAuthTokenRequest response $ref GoogleFirebaseInstallationsV1AuthTokenInfo revision 20250124 rootUrl https://firebaseinstallations.googleapis.com/ schemas GoogleFirebaseInstallationsV1AuthTokenInfo id GoogleFirebaseInstallationsV1AuthTokenInfo properties expiresIn description The duration for which this auth_token will be valid. In a response's JSON format, the value is encoded as a string with the suffix "s" (indicating seconds), preceded by the number of seconds. Example: "604800s" format google-duration type string token description A new FIS-Auth-Token, created for the Firebase Installation. type string type object GoogleFirebaseInstallationsV1GenerateAuthTokenRequest description The request to create a new temporary FIS-Auth-Token (which is a Bearer-Token for Installations). id GoogleFirebaseInstallationsV1GenerateAuthTokenRequest properties installation $ref GoogleFirebaseInstallationsV1Installation description Optional field that allows the Firebase Installation to update (some of) its attributes with FIS the server (ex: sdk_version) when it requests for a new FIS Auth-Token. type object GoogleFirebaseInstallationsV1Installation description next_id: 9 id GoogleFirebaseInstallationsV1Installation properties appId description (GMP)-App-ID - Firebase Application identifier, generated by FireData API type string authToken $ref GoogleFirebaseInstallationsV1AuthTokenInfo description The initial FIS Auth-Token, created for the Firebase Installation. This field is set only during response. authVersion description The version of the Firebase Installations Internal Authentication scheme. This value is used as Authorization-Type of HTTP-header "Authorization". Compare: https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication The internal client/server authentication of Firebase Installations may change in the future. Initial version is "FIS_v2". This field is optional. If not set the default version is assumed (FIS_v2). type string fid description Globally unique identifier of the Firebase Installation. In a CreateInstallationRequest, this should be the FID from the client, which should be initially randomly generated. In the corresponding response, this will be a unique FID that the client should then use thereafter, which will normally be the same as the FID supplied by the client, but which may be different if the FID supplied by the client is already in use or is otherwise unacceptable (e.g. invalid format). type string name description URI of the Firebase Installation with the following format: projects//installations/ Example: projects/35006771263/installations/eapzYQai_g8flVQyfKoGs7 This field is set only during response. type string refreshToken description A refresh token created for / assigned to the Firebase Installation by FIS. The Firebase Installation can use the refresh token to send requests to # GenerateAuthToken in order to request and generate new FIS Auth-Tokens. Used for FIS Internal Auth scheme FIS_v2. This field is set only during response. type string sdkVersion description The current version of the used FIS client-SDK. type string verificationKey description The verification-key (a.k.a. public-key) is used to authenticate the digital signatures sent by the Firebase Installation in requests to FIS. Used for FIS Internal Auth scheme FIS_v1. The public key is expected to be in X.509 format ("SubjectPublicKeyInfo"), compare RFC 5280 (https://tools.ietf.org/html/rfc5280#section-4.1). type string type object GoogleProtobufEmpty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id GoogleProtobufEmpty properties type object servicePath title Firebase Installations API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/firebaseml-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebaseml-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebaseml-v1beta2	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebaseml-v2beta	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/firebaseremoteconfig-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/firebaseremoteconfig-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/firebaseremoteconfigrealtime-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/firebaseremoteconfigrealtime-v1	values_changed root['revision'] new_value 20250206 old_value 20250203
prod/firebaserules-	values_changed root['revision'] new_value 20250127 old_value 20250113
prod/firebaserules-v1	values_changed root['revision'] new_value 20250127 old_value 20250113
prod/firebasestorage-	values_changed root['revision'] new_value 20250131 old_value 20250117
prod/firebasestorage-v1alpha	values_changed root['revision'] new_value 20250131 old_value 20250117
prod/firebasestorage-v1beta	values_changed root['revision'] new_value 20250131 old_value 20250117
prod/firebasevertexai-	dictionary_item_removed root['schemas']['GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig'] root['schemas']['GoogleCloudAiplatformV1beta1GenerationConfig']['properties']['thinkingConfig'] values_changed root['revision'] new_value 20250203 old_value 20250127
prod/firebasevertexai-v1	values_changed root['revision'] new_value 20250203 old_value 20250127
prod/firebasevertexai-v1beta	dictionary_item_removed root['schemas']['GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig'] root['schemas']['GoogleCloudAiplatformV1beta1GenerationConfig']['properties']['thinkingConfig'] values_changed root['revision'] new_value 20250203 old_value 20250127
prod/firestore-	values_changed root['revision'] new_value 20250204 old_value 20250120
prod/firestore-v1	values_changed root['revision'] new_value 20250204 old_value 20250120
prod/firestore-v1beta1	values_changed root['revision'] new_value 20250204 old_value 20250120
prod/firestore-v1beta2	values_changed root['revision'] new_value 20250204 old_value 20250120
prod/fundingchoicestags-pa-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/fundingchoicestags-pa-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/gapilibraryexample-pa-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/gapilibraryexample-pa-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/gkebackup-	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/gkebackup-v1	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/gkebackup-v1agent	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/gkehub-	values_changed root['revision'] new_value 20250127 old_value 20250122
prod/gkehub-v1	values_changed root['revision'] new_value 20250127 old_value 20250122
prod/gkehub-v1beta	values_changed root['revision'] new_value 20250127 old_value 20250122
prod/gkehub-v2	values_changed root['revision'] new_value 20250127 old_value 20250122
prod/gkehub-v2alpha	values_changed root['revision'] new_value 20250127 old_value 20250122
prod/global-dialogflow-	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/global-dialogflow-v1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/global-dialogflow-v2	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/global-dialogflow-v2beta1	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/global-dialogflow-v3	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/global-dialogflow-v3alpha1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/global-discoveryengine-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/global-discoveryengine-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/global-discoveryengine-v1alpha	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/global-discoveryengine-v1beta	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/gmailpostmastertools-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/gmailpostmastertools-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/gmailpostmastertools-v1beta1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/gtmvendor-	values_changed root['revision'] new_value 20250205 old_value 20250129
prod/gtmvendor-v1	values_changed root['revision'] new_value 20250205 old_value 20250129
prod/iap-	values_changed root['revision'] new_value 20250203 old_value 20250128
prod/iap-v1	values_changed root['revision'] new_value 20250203 old_value 20250128
prod/iap-v1beta1	values_changed root['revision'] new_value 20250203 old_value 20250128
prod/libraryagent-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/libraryagent-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/listallowedkids-	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/listallowedkids-v1	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/livestream-v1	values_changed root['revision'] new_value 20250131 old_value 20250124
prod/loadtest-hangouts-	values_changed root['revision'] new_value 20250207 old_value 20250205
prod/loadtest-hangouts-v1	values_changed root['revision'] new_value 20250207 old_value 20250205
prod/localservices-v1	values_changed root['revision'] new_value 20241219 old_value 20241212
prod/logging-	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/logging-v1	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/logging-v1beta3	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/logging-v2	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/logging-v2beta1	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/marketingplatformadmin-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/marketingplatformadmin-v1alpha	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/me-central1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-central2-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-west1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-west1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-west1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-west1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-west1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-west1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/me-west1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/meet-	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/meet-v1	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/meet-v2	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/meshconfig-	values_changed root['revision'] new_value 20250202 old_value 20250120
prod/meshconfig-v1alpha1	values_changed root['revision'] new_value 20250202 old_value 20250120
prod/meshconfig-v1internal	values_changed root['revision'] new_value 20250202 old_value 20250120
prod/metastore-v1beta	values_changed root['revision'] new_value 20250204 old_value 20250123
prod/microservices-	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://microservices.googleapis.com/ batchPath batch canonicalName Microservices description Manages microservices features, such as observability for gRPC workloads. discoveryVersion v1 documentationLink https://cloud.google.com/stackdriver/docs/solutions/grpc fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id microservices:v1alpha1 kind discovery#restDescription mtlsRootUrl https://microservices.mtls.googleapis.com/ name microservices ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations methods get description Gets information about a location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId} httpMethod GET id microservices.projects.locations.get parameterOrder name parameters name description Resource name for the location. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Location scopes https://www.googleapis.com/auth/cloud-platform list description Lists information about the supported locations for this service. flatPath v1alpha1/projects/{projectsId}/locations httpMethod GET id microservices.projects.locations.list parameterOrder name parameters filter description A 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). location query type string name description The resource that owns the locations collection, if applicable. location path pattern ^projects/[^/]+$ required True type string pageSize description The maximum number of results to return. If not set, the service selects a default. format int32 location query type integer pageToken description A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. location query type string path v1alpha1/{+name}/locations response $ref ListLocationsResponse scopes https://www.googleapis.com/auth/cloud-platform resources features methods create description Creates a new Feature in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/features httpMethod POST id microservices.projects.locations.features.create parameterOrder parent parameters featureId description Required. Id of the requesting object If auto-generating Id server-side, remove this field and feature_id from the method_signature of Create RPC location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+parent}/features request $ref Feature response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Feature. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/features/{featuresId} httpMethod DELETE id microservices.projects.locations.features.delete parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/features/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Feature. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/features/{featuresId} httpMethod GET id microservices.projects.locations.features.get parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/features/[^/]+$ required True type string path v1alpha1/{+name} response $ref Feature scopes https://www.googleapis.com/auth/cloud-platform list description Lists Features in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/features httpMethod GET id microservices.projects.locations.features.list parameterOrder parent parameters filter description Filtering results location query type string orderBy description Hint for how to order the results location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListFeaturesRequest location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/features response $ref ListFeaturesResponse scopes https://www.googleapis.com/auth/cloud-platform operations methods cancel description Starts 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`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel httpMethod POST id microservices.projects.locations.operations.cancel parameterOrder name parameters name description The name of the operation resource to be cancelled. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name}:cancel request $ref CancelOperationRequest response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes 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`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod DELETE id microservices.projects.locations.operations.delete parameterOrder name parameters name description The name of the operation resource to be deleted. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id microservices.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations httpMethod GET id microservices.projects.locations.operations.list parameterOrder name parameters filter description The standard list filter. location query type string name description The name of the operation's parent resource. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string pageSize description The standard list page size. format int32 location query type integer pageToken description The standard list page token. location query type string path v1alpha1/{+name}/operations response $ref ListOperationsResponse scopes https://www.googleapis.com/auth/cloud-platform revision 20250129 rootUrl https://microservices.googleapis.com/ schemas CancelOperationRequest description The request message for Operations.CancelOperation. id CancelOperationRequest properties type object Empty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id Empty properties type object Feature description Message describing Feature object id Feature properties createTime description Output only. [Output only] Create time stamp format google-datetime readOnly True type string labels additionalProperties type string description Labels as key value pairs type object name description name of resource type string updateTime description Output only. [Output only] Update time stamp format google-datetime readOnly True type string type object ListFeaturesResponse description Message for response to listing Features id ListFeaturesResponse properties features description The list of Feature items $ref Feature type array nextPageToken description A token identifying a page of results the server should return. type string unreachable description Locations that could not be reached. items type string type array type object ListLocationsResponse description The response message for Locations.ListLocations. id ListLocationsResponse properties locations description A list of locations that matches the specified filter in the request. items $ref Location type array nextPageToken description The standard List next-page token. type string type object ListOperationsResponse description The response message for Operations.ListOperations. id ListOperationsResponse properties nextPageToken description The standard List next-page token. type string operations description A list of operations that matches the specified filter in the request. items $ref Operation type array type object Location description A resource that represents a Google Cloud location. id Location properties displayName description The friendly name for this location, typically a nearby city name. For example, "Tokyo". type string labels additionalProperties type string description Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} type object locationId description The canonical id for this location. For example: `"us-east1"`. type string metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-specific metadata. For example the available capacity at the given location. type object name description Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` type string type object Operation description This resource represents a long-running operation that is the result of a network API call. id Operation properties done description If 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. type boolean error $ref Status description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object OperationMetadata description Represents the metadata of the long-running operation. id OperationMetadata properties apiVersion description Output only. API version used to start the operation. readOnly True type string createTime description Output only. The time the operation was created. format google-datetime readOnly True type string endTime description Output only. The time the operation finished running. format google-datetime readOnly True type string requestedCancellation description Output 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`. readOnly True type boolean statusMessage description Output only. Human-readable status of the operation, if any. readOnly True type string target description Output only. Server-defined resource path for the target of the operation. readOnly True type string verb description Output only. Name of the verb executed by the operation. readOnly True type string type object Status description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id Status properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object servicePath title Microservices API version v1alpha1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/microservices-v1alpha1	values_changed root['revision'] new_value 20250129 old_value 20250108
prod/migrate-	values_changed root['revision'] new_value 20250204 old_value 20250202
prod/migrate-v1beta1	values_changed root['revision'] new_value 20250204 old_value 20250202
prod/migrateinterop-pa-	values_changed root['revision'] new_value 20250204 old_value 20250202
prod/migrateinterop-pa-v1beta1	values_changed root['revision'] new_value 20250204 old_value 20250202
prod/ml-	values_changed root['revision'] new_value 20250201 old_value 20250118
prod/ml-v1	values_changed root['revision'] new_value 20250201 old_value 20250118
prod/mlengine-pa-	values_changed root['revision'] new_value 20250201 old_value 20250118
prod/mlengine-pa-v1	values_changed root['revision'] new_value 20250201 old_value 20250118
prod/monitoring-	values_changed root['resources']['projects']['resources']['snoozes']['methods']['list']['parameters']['filter']['description'] new_value Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" old_value Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: ``` interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" ``` root['revision'] new_value 20250130 old_value 20250125
prod/monitoring-v1	dictionary_item_added root['schemas']['TemplateVariableCondition'] root['schemas']['VisibilityCondition'] root['schemas']['Widget']['properties']['visibilityCondition'] values_changed root['revision'] new_value 20250130 old_value 20250125
prod/monitoring-v3	values_changed root['resources']['projects']['resources']['snoozes']['methods']['list']['parameters']['filter']['description'] new_value Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" old_value Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: ``` interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" ``` root['revision'] new_value 20250130 old_value 20250125
prod/mybusinessaccountmanagement-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinessaccountmanagement-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinessbusinessinformation-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinessbusinessinformation-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinesslodging-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinesslodging-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinessnotifications-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinessnotifications-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinessplaceactions-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinessplaceactions-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinessqanda-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinessqanda-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinessverifications-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/mybusinessverifications-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/netapp-v1alpha1	dictionary_item_added root['schemas']['LocationMetadata']['properties']['supportedFlexPerformance'] values_changed root['revision'] new_value 20250129 old_value 20250123
prod/netapp-v1beta1	dictionary_item_added root['schemas']['LocationMetadata']['properties']['supportedFlexPerformance'] values_changed root['revision'] new_value 20250129 old_value 20250123
prod/northamerica-northeast1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast1-aiplatform-	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['featureGroups']['resources']['featureMonitors']['methods']['patch'] root['schemas']['GoogleCloudAiplatformV1beta1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1RolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1DeployedModel']['properties']['rolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1beta1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1beta1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1beta1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/northamerica-northeast1-aiplatform-v1	dictionary_item_added root['schemas']['GoogleCloudAiplatformV1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/northamerica-northeast1-aiplatform-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/northamerica-northeast1-aiplatform-v1beta1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['featureGroups']['resources']['featureMonitors']['methods']['patch'] root['schemas']['GoogleCloudAiplatformV1beta1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1RolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1DeployedModel']['properties']['rolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1beta1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1beta1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1beta1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/northamerica-northeast1-artifactregistry-	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/northamerica-northeast1-artifactregistry-v1	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/northamerica-northeast1-artifactregistry-v1beta2	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/northamerica-northeast1-cloudkms-v1	values_changed root['revision'] new_value 20250203 old_value 20250124
prod/northamerica-northeast1-connectgateway-	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/northamerica-northeast1-connectgateway-v1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/northamerica-northeast1-connectgateway-v1beta1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://connectgateway.googleapis.com/ batchPath batch canonicalName CONNECT GATEWAY description The Connect Gateway service allows connectivity from external parties to connected Kubernetes clusters. discoveryVersion v1 documentationLink https://cloud.google.com/kubernetes-engine/connect/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id connectgateway:v1beta1 kind discovery#restDescription mtlsRootUrl https://connectgateway.mtls.googleapis.com/ name connectgateway ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations resources memberships methods generateCredentials description GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway. flatPath v1beta1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateCredentials httpMethod GET id connectgateway.projects.locations.memberships.generateCredentials parameterOrder name parameters forceUseAgent description Optional. Whether to force the use of Connect Agent-based transport in the generated kubeconfig. This will return a configuration that uses Connect Agent as the underlying transport mechanism for cluster types that would otherwise have used a different transport. Requires that Connect Agent be installed on the cluster. Setting this field to false is equivalent to not setting it. location query type boolean impersonatedServiceAccount description Optional. Service account to impersonate when using the generated kubeconfig. This should only be specified if all calls using this kubeconfig should be made using impersonation of the same service account. location query type string kubernetesNamespace description Optional. The namespace to use in the generated kubeconfig context. If this field is specified, the server will set the `namespace` field in kubeconfig context. If not specified, the `namespace` field is omitted. location query type string name description Required. The Fleet membership resource. location path pattern ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$ required True type string operatingSystem description Optional. The operating system on which the generated kubeconfig will be used. enum OPERATING_SYSTEM_UNSPECIFIED OPERATING_SYSTEM_WINDOWS enumDescriptions Generates a kubeconfig that works for all operating systems not defined below. Generates a kubeconfig that is specifically designed to work with Windows. location query type string version description Optional. The Connect Gateway version to be used in the generated kubeconfig. Leave this field blank to let the server choose the version (recommended). location query type string path v1beta1/{+name}:generateCredentials response $ref GenerateCredentialsResponse scopes https://www.googleapis.com/auth/cloud-platform v1beta1 methods delete description DeleteResource performs an HTTP DELETE on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod DELETE id connectgateway.delete parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform get description GetResource performs an HTTP GET request on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod GET id connectgateway.get parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform patch description PatchResource performs an HTTP PATCH on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod PATCH id connectgateway.patch parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform postResource description PostResource performs an HTTP POST on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod POST id connectgateway.postResource parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform putResource description PutResource performs an HTTP PUT on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod PUT id connectgateway.putResource parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform revision 20250201 rootUrl https://connectgateway.googleapis.com/ schemas GenerateCredentialsResponse description Connection information for a particular membership. id GenerateCredentialsResponse properties endpoint description The generated URI of the cluster as accessed through the Connect Gateway API. type string kubeconfig description A full YAML kubeconfig in serialized format. format byte type string type object HttpBody description Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. id HttpBody properties contentType description The HTTP Content-Type header value specifying the content type of the body. type string data description The HTTP request/response body as raw binary. format byte type string extensions description Application specific response metadata. Must be set in the first response for streaming APIs. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array type object servicePath title Connect Gateway API version v1beta1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/northamerica-northeast1-content-texttospeech-	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/northamerica-northeast1-content-texttospeech-v1	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/northamerica-northeast1-content-texttospeech-v1beta1	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/northamerica-northeast1-contentwarehouse-v1	values_changed root['revision'] new_value 20250206 old_value 20241210
prod/northamerica-northeast1-contentwarehouse-v1beta1	values_changed root['revision'] new_value 20250206 old_value 20241210
prod/northamerica-northeast1-datalineage-	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/northamerica-northeast1-datalineage-v1	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/northamerica-northeast1-dialogflow-	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/northamerica-northeast1-dialogflow-v1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/northamerica-northeast1-dialogflow-v2	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/northamerica-northeast1-dialogflow-v2beta1	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/northamerica-northeast1-dialogflow-v3	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/northamerica-northeast1-dialogflow-v3alpha1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/northamerica-northeast1-dialogflow-v3beta1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/northamerica-northeast1-gkemulticloud-	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/northamerica-northeast1-gkemulticloud-v1	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/northamerica-northeast1-healthcare-	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['methods']['retrieveRendered']['parameters']['viewport'] root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['resources']['frames']['methods']['retrieveRendered']['parameters']['viewport'] values_changed root['revision'] new_value 20250129 old_value 20250127
prod/northamerica-northeast1-healthcare-v1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['methods']['retrieveRendered']['parameters']['viewport'] root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['resources']['frames']['methods']['retrieveRendered']['parameters']['viewport'] values_changed root['revision'] new_value 20250129 old_value 20250127
prod/northamerica-northeast1-healthcare-v1alpha2	values_changed root['revision'] new_value 20250129 old_value 20250127
prod/northamerica-northeast1-healthcare-v1beta1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['methods']['retrieveRendered']['parameters']['viewport'] root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['resources']['frames']['methods']['retrieveRendered']['parameters']['viewport'] values_changed root['revision'] new_value 20250129 old_value 20250127
prod/northamerica-northeast1-logging-v1beta3	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/northamerica-northeast1-logging-v2beta1	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/northamerica-northeast1-run-	values_changed root['revision'] new_value 20250205 old_value 20250127 root['schemas']['GoogleCloudRunV2Container']['properties']['baseImageUri']['description'] new_value Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. old_value Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.
prod/northamerica-northeast1-run-v1	values_changed root['revision'] new_value 20250205 old_value 20250127
prod/northamerica-northeast1-run-v2	values_changed root['revision'] new_value 20250205 old_value 20250127 root['schemas']['GoogleCloudRunV2Container']['properties']['baseImageUri']['description'] new_value Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. old_value Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.
prod/northamerica-northeast1-texttospeech-	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/northamerica-northeast1-texttospeech-v1	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/northamerica-northeast1-texttospeech-v1beta1	values_changed root['revision'] new_value 20250129 old_value 20250124
prod/northamerica-northeast1-workflowexecutions-	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/northamerica-northeast1-workflowexecutions-v1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/northamerica-northeast1-workflowexecutions-v1alpha1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/northamerica-northeast1-workflowexecutions-v1beta	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/northamerica-northeast2-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast2-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast2-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast2-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast2-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast2-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast2-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/northamerica-northeast2-aiplatform-	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['featureGroups']['resources']['featureMonitors']['methods']['patch'] root['schemas']['GoogleCloudAiplatformV1beta1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1RolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1DeployedModel']['properties']['rolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1beta1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1beta1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1beta1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/northamerica-northeast2-aiplatform-v1	dictionary_item_added root['schemas']['GoogleCloudAiplatformV1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/northamerica-northeast2-aiplatform-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/northamerica-northeast2-aiplatform-v1beta1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['featureGroups']['resources']['featureMonitors']['methods']['patch'] root['schemas']['GoogleCloudAiplatformV1beta1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1RolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1DeployedModel']['properties']['rolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1beta1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1beta1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1beta1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/northamerica-northeast2-artifactregistry-	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/northamerica-northeast2-artifactregistry-v1beta2	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/northamerica-northeast2-assuredworkloads-	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/northamerica-northeast2-assuredworkloads-v1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/northamerica-northeast2-assuredworkloads-v1beta1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/northamerica-northeast2-datalineage-	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/northamerica-northeast2-datalineage-v1	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/northamerica-northeast2-dataproc-	values_changed root['revision'] new_value 20250122 old_value 20250131
prod/northamerica-northeast2-dataproc-v1	dictionary_item_removed root['schemas']['GceClusterConfig']['properties']['resourceManagerTags'] values_changed root['revision'] new_value 20250122 old_value 20250131
prod/northamerica-northeast2-healthcare-	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['methods']['retrieveRendered']['parameters']['viewport'] root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['resources']['frames']['methods']['retrieveRendered']['parameters']['viewport'] values_changed root['revision'] new_value 20250129 old_value 20250127
prod/northamerica-northeast2-healthcare-v1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['methods']['retrieveRendered']['parameters']['viewport'] root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['resources']['frames']['methods']['retrieveRendered']['parameters']['viewport'] values_changed root['revision'] new_value 20250129 old_value 20250127
prod/northamerica-northeast2-healthcare-v1alpha2	values_changed root['revision'] new_value 20250129 old_value 20250127
prod/northamerica-northeast2-healthcare-v1beta1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['methods']['retrieveRendered']['parameters']['viewport'] root['resources']['projects']['resources']['locations']['resources']['datasets']['resources']['dicomStores']['resources']['studies']['resources']['series']['resources']['instances']['resources']['frames']['methods']['retrieveRendered']['parameters']['viewport'] values_changed root['revision'] new_value 20250129 old_value 20250127
prod/northamerica-northeast2-monitoring-	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/northamerica-northeast2-monitoring-v1	dictionary_item_removed root['schemas']['PieChartDataSet']['properties']['breakdowns'] values_changed root['revision'] new_value 20250127 old_value 20250120
prod/northamerica-northeast2-monitoring-v3	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/northamerica-northeast2-run-	values_changed root['revision'] new_value 20250205 old_value 20250127 root['schemas']['GoogleCloudRunV2Container']['properties']['baseImageUri']['description'] new_value Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. old_value Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.
prod/northamerica-northeast2-run-v1	values_changed root['revision'] new_value 20250205 old_value 20250127
prod/northamerica-northeast2-run-v2	values_changed root['revision'] new_value 20250205 old_value 20250127 root['schemas']['GoogleCloudRunV2Container']['properties']['baseImageUri']['description'] new_value Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. old_value Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.
prod/northamerica-northeast2-workflowexecutions-	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/northamerica-northeast2-workflowexecutions-v1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/northamerica-northeast2-workflowexecutions-v1alpha1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/northamerica-northeast2-workflowexecutions-v1beta	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/notebooks-v1beta1	values_changed root['revision'] new_value 20250101 old_value 20250108
prod/oauth2-v1	values_changed root['revision'] new_value 20250205 old_value 20250124
prod/openidconnect-	values_changed root['revision'] new_value 20250205 old_value 20250124
prod/optimization-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/optimization-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/oslogin-	values_changed root['revision'] new_value 20250131 old_value 20250126
prod/oslogin-v1	values_changed root['revision'] new_value 20250131 old_value 20250126
prod/oslogin-v1beta	values_changed root['revision'] new_value 20250131 old_value 20250126
prod/parallelstore-	values_changed root['revision'] new_value 20250129 old_value 20250127
prod/parallelstore-v1	values_changed root['revision'] new_value 20250129 old_value 20250127
prod/parallelstore-v1alpha	values_changed root['revision'] new_value 20250129 old_value 20250127
prod/parallelstore-v1beta	values_changed root['revision'] new_value 20250129 old_value 20250127
prod/payments-pa-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/payments-pa-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/payments-pa.sandbox-	values_changed root['revision'] new_value 20250207 old_value 20250205
prod/payments-pa.sandbox-v1	values_changed root['revision'] new_value 20250207 old_value 20250205
prod/paymentsresellersubscription-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/paymentsresellersubscription-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/people-	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/people-pa-	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/people-pa-v1	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/people-pa-v2	values_changed root['revision'] new_value 20250204 old_value 20250203
prod/people-v1	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/photoslibrary-	values_changed root['revision'] new_value 20250206 old_value 20250130
prod/photoslibrary-v1	values_changed root['revision'] new_value 20250206 old_value 20250130
prod/photospicker-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/photospicker-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/playconsoleapps-pa-	values_changed root['revision'] new_value 20250207 old_value 20250205
prod/playconsoleapps-pa-v1	values_changed root['revision'] new_value 20250207 old_value 20250205
prod/playdeveloperreporting-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/playdeveloperreporting-v1alpha1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/playdeveloperreporting-v1beta1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/playgrouping-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/playgrouping-v1alpha1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/playintegrity-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/playintegrity-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/pollen-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/pollen-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/ppissuer-	values_changed root new_value basePath baseUrl https://ppissuer.googleapis.com/ batchPath batch canonicalName Google Privacy Pass Issuer API description Privacy Pass Issuer API discoveryVersion v1 documentationLink https://cloud.google.com/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id ppissuer:v1 kind discovery#restDescription mtlsRootUrl https://ppissuer.mtls.googleapis.com/ name ppissuer ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources revision 20250206 rootUrl https://ppissuer.googleapis.com/ schemas servicePath title Privacy Pass Issuer API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/ppissuer-v1	values_changed root['revision'] new_value 20250206 old_value 20250203
prod/preprod-paymentsresellersubscription-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/preprod-paymentsresellersubscription-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/preprod-recaptchaenterprise-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/preprod-recaptchaenterprise-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/preprod-recaptchaenterprise-v1beta1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/preprod-sasportal-	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/preprod-sasportal-v1	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/preprod-sasportal-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/preprod-servicecontrol-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/preprod-servicecontrol-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/preprod-servicecontrol-v2	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/pubsublite-	values_changed root['revision'] new_value 20250201 old_value 20250124
prod/pubsublite-v1	values_changed root['revision'] new_value 20250201 old_value 20250124
prod/realtimebidding-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/realtimebidding-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/roads-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/roads-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/routeoptimization-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/routeoptimization-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/routes-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/routes-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/run-	dictionary_item_added root['schemas']['GoogleDevtoolsCloudbuildV1BuildOptions']['properties']['pubsubTopic'] values_changed root['revision'] new_value 20250131 old_value 20250124 root['schemas']['GoogleCloudRunV2Container']['properties']['baseImageUri']['description'] new_value Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. old_value Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.
prod/run-v2	dictionary_item_added root['schemas']['GoogleDevtoolsCloudbuildV1BuildOptions']['properties']['pubsubTopic'] values_changed root['revision'] new_value 20250131 old_value 20250124 root['schemas']['GoogleCloudRunV2Container']['properties']['baseImageUri']['description'] new_value Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. old_value Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.
prod/runapps-	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://runapps.googleapis.com/ batchPath batch canonicalName Run Apps description API for managing Cloud Run Integrations. discoveryVersion v1 documentationLink https://cloud.google.com/run/docs/integrate/using-gcp-services#integrations fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id runapps:v1alpha1 kind discovery#restDescription mtlsRootUrl https://runapps.mtls.googleapis.com/ name runapps ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations methods get description Gets information about a location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId} httpMethod GET id runapps.projects.locations.get parameterOrder name parameters name description Resource name for the location. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Location scopes https://www.googleapis.com/auth/cloud-platform list description Lists information about the supported locations for this service. flatPath v1alpha1/projects/{projectsId}/locations httpMethod GET id runapps.projects.locations.list parameterOrder name parameters filter description A 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). location query type string name description The resource that owns the locations collection, if applicable. location path pattern ^projects/[^/]+$ required True type string pageSize description The maximum number of results to return. If not set, the service selects a default. format int32 location query type integer pageToken description A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. location query type string path v1alpha1/{+name}/locations response $ref ListLocationsResponse scopes https://www.googleapis.com/auth/cloud-platform resources applications methods create description Creates a new Application in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications httpMethod POST id runapps.projects.locations.applications.create parameterOrder parent parameters applicationId description Required. Id of the requesting object If auto-generating Id server-side, remove this field and application_id from the method_signature of Create RPC location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string requestId description An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string validateOnly description Optional. If set, validate the request, but do not actually persist it. location query type boolean path v1alpha1/{+parent}/applications request $ref Application response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId} httpMethod DELETE id runapps.projects.locations.applications.delete parameterOrder name parameters force description If set to true, any child deployments of this application will also be deleted. Followed the best practice from https://aip.dev/135#cascading-delete location query type boolean name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId} httpMethod GET id runapps.projects.locations.applications.get parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+name} response $ref Application scopes https://www.googleapis.com/auth/cloud-platform getStatus description Gets status of a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/status httpMethod GET id runapps.projects.locations.applications.getStatus parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string readMask description Field mask used for limiting the resources to query status on. format google-fieldmask location query type string resources description Optional. Specify which resource to query status for. If not provided, all resources status are queried. location query repeated True type string path v1alpha1/{+name}/status response $ref ApplicationStatus scopes https://www.googleapis.com/auth/cloud-platform list description Lists Applications in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications httpMethod GET id runapps.projects.locations.applications.list parameterOrder parent parameters filter description Filtering results location query type string orderBy description Hint for how to order the results location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListApplicationsRequest location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/applications response $ref ListApplicationsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId} httpMethod PATCH id runapps.projects.locations.applications.patch parameterOrder name parameters allowMissing description Optional. If set, a new Application will be created if it does not already exist. In this situation, `update_mask` is ignored. location query type boolean name description name of resource location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string requestId description An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string validateOnly description Optional. If set, validate the request, but do not actually persist it. location query type boolean path v1alpha1/{+name} request $ref Application response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform resources deployments methods create description Creates a new Deployment in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/deployments httpMethod POST id runapps.projects.locations.applications.deployments.create parameterOrder parent parameters deploymentId description Required. Id of the requesting object If auto-generating Id server-side, remove this field and deployment_id from the method_signature of Create RPC location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string requestId description An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string validateOnly description If true, the Create request will just do a dry run of the deploy instead of actuating anything. location query type boolean path v1alpha1/{+parent}/deployments request $ref Deployment response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Deployment. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/deployments/{deploymentsId} httpMethod GET id runapps.projects.locations.applications.deployments.get parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+/deployments/[^/]+$ required True type string path v1alpha1/{+name} response $ref Deployment scopes https://www.googleapis.com/auth/cloud-platform list description Lists Deployments in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/deployments httpMethod GET id runapps.projects.locations.applications.deployments.list parameterOrder parent parameters filter description Filtering results location query type string orderBy description Hint for how to order the results location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListDeploymentsRequest location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+parent}/deployments response $ref ListDeploymentsResponse scopes https://www.googleapis.com/auth/cloud-platform operations methods cancel description Starts 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`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel httpMethod POST id runapps.projects.locations.operations.cancel parameterOrder name parameters name description The name of the operation resource to be cancelled. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name}:cancel request $ref CancelOperationRequest response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes 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`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod DELETE id runapps.projects.locations.operations.delete parameterOrder name parameters name description The name of the operation resource to be deleted. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id runapps.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations httpMethod GET id runapps.projects.locations.operations.list parameterOrder name parameters filter description The standard list filter. location query type string name description The name of the operation's parent resource. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string pageSize description The standard list page size. format int32 location query type integer pageToken description The standard list page token. location query type string path v1alpha1/{+name}/operations response $ref ListOperationsResponse scopes https://www.googleapis.com/auth/cloud-platform revision 20250122 rootUrl https://runapps.googleapis.com/ schemas Application description Message describing Application object Next tag: 9 id Application properties annotations additionalProperties type string description Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. This field follows Kubernetes annotations' namespacing, limits, and rules. More info: http://kubernetes.io/docs/user-guide/annotations type object config $ref Config description The application configuration. On output, both intent repo and application config are populated. On input, only one can be modified at a time. createTime description Output only. Create time stamp format google-datetime readOnly True type string deleteTime description Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. format google-datetime readOnly True type string displayName description A mutable, user-defined name for the application. type string etag description Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. readOnly True type string labels additionalProperties type string description Labels as key value pairs type object name description name of resource type string reconciling description Output only. Indicates whether the resource's reconciliation is still in progress. readOnly True type boolean updateTime description Output only. Update time stamp format google-datetime readOnly True type string type object ApplicationStatus description Status of the application. id ApplicationStatus properties annotations additionalProperties type string description Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. This field follows Kubernetes annotations' namespacing, limits, and rules. More info: http://kubernetes.io/docs/user-guide/annotations type object createTime description Output only. Create time stamp format google-datetime readOnly True type string displayName description Display name type string etag description Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. readOnly True type string name description The resource name of the application status, in the following form: `projects/{project}/locations/{location}/applications/{application}/status` type string reconciling description Output only. Indicates whether the resource's reconciliation is still in progress. readOnly True type boolean resourceStatuses description Output only. The status of the resources in this application. items $ref ResourceStatus readOnly True type array resources additionalProperties $ref ResourceStatus deprecated True description The map of resource status where the key is the name of resources and the value is the resource status. Deprecated: use resource_statuses instead. type object updateTime description Output only. Time at which the status was last updated. format google-datetime readOnly True type string type object Binding description Binding describes the edge between the Resource it's defined in and the specified Resource. id Binding properties config additionalProperties description Properties of the object. type any description Configuration allows the caller to provide configurations that are either specific to the binding or clarify *how* the binding works. The configuration has an associated typekit-specified JSONSchema (https://json-schema.org/) that defines the expected shape. type object targetRef $ref ResourceRef description TargetRef describes the target resource. type object BindingStatus description The binding status of a resource id BindingStatus properties annotations additionalProperties type string description Annotations of the Cloud Run service for the binded resource. type object environmentVariables additionalProperties type string description Environment variables of the Cloud Run service for the binded resource. type object resourceName description Name of the binded resource. type string resourceType description Type of the binded resource. type string serviceAccount description Service account email used by the Cloud Run service for the binded resource. type string serviceName description Name of the Cloud Run service. type string type object CancelOperationRequest description The request message for Operations.CancelOperation. id CancelOperationRequest properties type object Config description Message for the Application Config Next tag: 6 id Config properties config description A byte array encapsulating the contents of the application config. This can be of any type of supported config (Simple Yaml, multi-file in-app config, etc.) format byte type string resourceList description Optional. The list of resources defined using the type-agnostic Resource definitions. items $ref Resource type array type object Deployment description Message describing Deployment object Next tag: 15 id Deployment properties annotations additionalProperties type string description Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. This field follows Kubernetes annotations' namespacing, limits, and rules. More info: http://kubernetes.io/docs/user-guide/annotations type object application description Output only. The name of the parent application. readOnly True type string createSelector $ref Selector description Optional selectors that should be applied to limit the scope of the deployment creation. createTime description Output only. Create time stamp format google-datetime readOnly True type string deleteSelector $ref Selector description Optional selectors that should be applied to limit the scope of the deployment deletion. deleteTime description Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. format google-datetime readOnly True type string etag description Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. readOnly True type string labels additionalProperties type string description Labels as key value pairs type object name description Output only. Canonical name of resource readOnly True type string reconciling description Output only. Indicates whether the resource's reconciliation is still in progress. readOnly True type boolean serviceAccount description Optional. The service account that will be used to actuate the deployment. type string status $ref DeploymentStatus description Output only. The status of the deployment readOnly True updateTime description Output only. Update time stamp format google-datetime readOnly True type string type object DeploymentOperationMetadata description Operation metadata for Deployment.Create. Next tag: 8 id DeploymentOperationMetadata properties apiVersion description The API version which triggered this operation. type string cancelRequested description Is cancelation requested for this operation. type boolean createTime description The time this operation was created. format google-datetime type string endTime description The time this operation ended or empty if it is still active. format google-datetime type string resourceStatus description The ongoinging state of resources that are being deployed. Order is not guaranteed to be stable between multiple reads of the same ongoing operation. items $ref ResourceDeploymentStatus type array target description Resource path for the target resource of the operation. type string verb description The verb associated with the API method which triggered this operation. type string type object DeploymentStatus description Message to encapsulate the current status of the deployment. id DeploymentStatus properties error $ref Status description Output only. Error status of the deployment if the deployment failed. The error.details field will contain the same information as the Deployment LRO error_details field in adherence to https://google.aip.dev/193. readOnly True errorMessage deprecated True description The error message associated with a failed deployment state, if applicable. type string jobDetails deprecated True description Details of each deploy job. items $ref JobDetails type array resourceStatus description The state of resources that are being deployed. Order is not guaranteed to be stable when deployment is in progress. items $ref ResourceDeploymentStatus type array state description The state associated with the deployment. enum STATE_UNSPECIFIED FAILED SUCCEEDED IN_PROGRESS enumDescriptions Default value. This value is unused. Deployment completed with failure. Deployment completed successfully. Deployment is running and has not completed. type string type object Empty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id Empty properties type object FirebaseHostingStatus description Detailed status for Firebase Hosting resource. id FirebaseHostingStatus properties domains description List of domains associated with the firebase hosting site. items type string type array hostingConfig description Hosting configuration created by Serverless Stacks. type string type object JobComponent deprecated True description Message to encapsulate component actuated by a job. JobComponent does not represent a GCP API resource. id JobComponent properties operation description Operation to be performed on component. enum COMPONENT_OPERATION_UNSPECIFIED APPLY DESTROY enumDescriptions ComponentOperation unset. Apply configuration to component. Destroy component. type string typedName $ref TypedName description TypedName is the component name and its type. type object JobDetails deprecated True description Message to encapsulate the current status deployment job. id JobDetails properties components description Components to be actuated by the job. items $ref JobComponent type array jobName description Name of deployment job. Format: projects/{project}/locations/{location}/builds/{build} type string jobUri description URI of deployment job within Google Cloud Console. type string state description State of deployment job. enum STATE_UNSPECIFIED FAILED SUCCEEDED IN_PROGRESS enumDescriptions Default value. This value is unused. Job completed with failure. Job completed successfully. Job is running and has not completed. type string type object ListApplicationsResponse description Message for response to listing Applications id ListApplicationsResponse properties applications description The list of Application items $ref Application type array nextPageToken description A token identifying a page of results the server should return. type string unreachable description Locations that could not be reached. items type string type array type object ListDeploymentsResponse description Message for response to listing Deployments id ListDeploymentsResponse properties deployments description The list of Deployment items $ref Deployment type array nextPageToken description A token identifying a page of results the server should return. type string unreachable description Locations that could not be reached. items type string type array type object ListLocationsResponse description The response message for Locations.ListLocations. id ListLocationsResponse properties locations description A list of locations that matches the specified filter in the request. items $ref Location type array nextPageToken description The standard List next-page token. type string type object ListOperationsResponse description The response message for Operations.ListOperations. id ListOperationsResponse properties nextPageToken description The standard List next-page token. type string operations description A list of operations that matches the specified filter in the request. items $ref Operation type array type object Location description A resource that represents a Google Cloud location. id Location properties displayName description The friendly name for this location, typically a nearby city name. For example, "Tokyo". type string labels additionalProperties type string description Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} type object locationId description The canonical id for this location. For example: `"us-east1"`. type string metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-specific metadata. For example the available capacity at the given location. type object name description Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` type string type object Operation description This resource represents a long-running operation that is the result of a network API call. id Operation properties done description If 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. type boolean error $ref Status description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object OperationMetadata description Represents the metadata of the long-running operation. id OperationMetadata properties apiVersion description API version used to start the operation. type string createTime description The time the operation was created. format google-datetime type string endTime description The time the operation finished running. format google-datetime type string requestedCancellation description Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. type boolean statusMessage description Human-readable status of the operation, if any. type string target description Server-defined resource path for the target of the operation. type string verb description Name of the verb executed by the operation. type string type object Resource description Resource defines a Stacks resource. Next tag: 8 id Resource properties bindings description Bindings describe the resources that this resource references. For Ingress Services, this includes Components. For Components, this includes Backing Services. For Backing Services, this is empty. items $ref Binding type array config additionalProperties description Properties of the object. type any description Configuration is the typekit-specified set of fields that define the resource. The configuration has an associated typekit-specified JSONSchema (https://json-schema.org/) that defines the expected shape. type object id $ref ResourceID description Resource ID describes the resource that's bound. latestDeployment description Output only. The deployment name for the most recent deployment that has been triggered for a given resource. If a resource was never deployed then this field will be empty. readOnly True type string subresources description Subresources is the set of subresources within this resource. Support for this field depends on the type of the Resource and is defined by the corresponding Typekit. items $ref Resource type array type object ResourceComponentStatus description Status for a component of a resource. id ResourceComponentStatus properties consoleLink description Pantheon link for the resource. This does not exist for every resource that makes up the SAF resource. type string diverged description Indicates that this resource component has been altered and may not match the expected state. type boolean name description The name the resource component. Usually it's the name of the GCP resource, which was used inside the Terraform Resource block that defines it. (e.g. cri-domain-cert) type string reason description The reason why this resource component to be in its state. type string selfLink description Fully qualified URL to the object represented by this resource component. type string state description The state of the resource component. enum STATE_UNSPECIFIED DEPLOYED MISSING PROVISIONING ACTIVE FAILED enumDescriptions The status of this component is unspecified. The component has been deployed. The component is missing. The component has been deployed and is provisioning. The component has been deployed and is working as intended. This is intended for resources that have a health indicator. The component has failed and the full error message will be populated in the resource. type string type description The Terraform Resource Type of the GCP resource (e.g. "google_compute_managed_ssl_certificate"). type string type object ResourceDeploymentError description Message describing the error that occurred for the respective resource. id ResourceDeploymentError properties errorMessage description Output only. Error details provided by deployment. readOnly True type string httpCode description Output only. HTTP error code provided by the deployment. format int32 readOnly True type integer type object ResourceDeploymentStatus description Message decribing the status of a resource being deployed. Next tag: 7 id ResourceDeploymentStatus properties errorMessage deprecated True description The error details if the state is FAILED. type string errors description Output only. The error details if the state is FAILED. items $ref ResourceDeploymentError readOnly True type array id $ref ResourceID description Output only. ID of the resource. readOnly True name $ref TypedName deprecated True description Name of the resource. operation description Operation to be performed on the resource . enum OPERATION_UNSPECIFIED APPLY DESTROY enumDescriptions Default value indicating the operation is unknown. Apply configuration to resource. Destroy resource. type string state description Current status of the resource. enum STATE_UNSPECIFIED NOT_STARTED RUNNING FINISHED SUCCEEDED FAILED enumDeprecated False False False True False False enumDescriptions Default value indicating the state is unknown. Resource queued for deployment. Deployment in progress. Deployment completed. Deployment completed successfully. Deployment completed with failure. type string type object ResourceID description ResourceID encapsulates the definition of the identity of a resource. id ResourceID properties name description Name is the name of the resource. This name must be unique within the type. type string type description Type is the name of the resource. type string type object ResourceRef description ResourceRef encapsulates the definition of a reference to another resource. id ResourceRef properties id $ref ResourceID description The ID of another resource specified in the config. type object ResourceStatus description Status for a resource. id ResourceStatus properties bindingStatus deprecated True description The binding status related to this resource. Deprecated: it's not implemented. items $ref BindingStatus type array consoleLink description Pantheon link for the resource. For example, the custom domain will link to the GCLB page. type string diverged deprecated True description Indicates that a child component of this resource has been altered and may not match the expected state. Deprecated: it's not implemented. type boolean extraDetails additionalProperties description Properties of the object. type any description Extra details of the resource that are needed for the users to make use of the resources, such as IP Address of GCLB. type object firebaseHostingDetails $ref FirebaseHostingStatus deprecated True description Details for Firebase Hosting resource. Deprecated: use extra_details instead. id $ref ResourceID description ID of the resource. reason description The reason why this resource is in the current state. type string resourceComponentStatuses description Repeated field with status per component created for this resource. items $ref ResourceComponentStatus type array resourceName deprecated True description Name of the resource, pulled from the Application Config. Deprecated: use the id field instead. type string routerDetails $ref RouterStatus deprecated True description Detail Status of Router resource. Deprecated: use extra_details instead. state description The enum state of the resource. enum STATE_UNSPECIFIED ACTIVE FAILED MISSING UPDATING NOT_READY NOT_DEPLOYED enumDescriptions The status of this resource is unspecified. The resource is active. Some of the components of the resource are not working. The key components are missing after at least one successful deployment. The user could have manually removed a resource that was deployed. The resource is being deployed. Some of the resource's child resources are not in ready state. The resource is currently not deployed. This could happen if the resource was added to the application config, but was not deployed yet, or the resource was undeployed. type string type deprecated True description Type of resource. Deprecated: use the id field instead. type string type object RouterStatus description Detail Status of Router resource. id RouterStatus properties ipAddress description IP Address of the Google Cloud Load Balancer. type string type object Selector description Message for selecting the resources within an application. Next tag: 4 id Selector properties matchTypeNames description match_type_names is a list resource name + type to match. Use '*' or empty string for wildcard either the name or the type. E.g. type='service' name='' will match all services. type='*' name='default' will match all resources named as 'default'. items $ref TypedName type array type object Status description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id Status properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object TypedName description TypedName is a resource name + its type. Next tag: 4 id TypedName properties ignoreResourceConfig description Optional. If true, the config associated with the resource will not be applied, and the underlying live object config will be retained. If false (or unset), the set config will be applied. If the resource does not already exist, this flag will be ignored. This option is only supported for certain types. This field is only supported when provided as part of the selector. type boolean name description The name of the resource. type string type description The type of the resource. type string type object servicePath title Serverless Integrations API version v1alpha1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/runapps-v1alpha1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://runapps.googleapis.com/ batchPath batch canonicalName Run Apps description API for managing Cloud Run Integrations. discoveryVersion v1 documentationLink https://cloud.google.com/run/docs/integrate/using-gcp-services#integrations fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id runapps:v1alpha1 kind discovery#restDescription mtlsRootUrl https://runapps.mtls.googleapis.com/ name runapps ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations methods get description Gets information about a location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId} httpMethod GET id runapps.projects.locations.get parameterOrder name parameters name description Resource name for the location. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Location scopes https://www.googleapis.com/auth/cloud-platform list description Lists information about the supported locations for this service. flatPath v1alpha1/projects/{projectsId}/locations httpMethod GET id runapps.projects.locations.list parameterOrder name parameters filter description A 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). location query type string name description The resource that owns the locations collection, if applicable. location path pattern ^projects/[^/]+$ required True type string pageSize description The maximum number of results to return. If not set, the service selects a default. format int32 location query type integer pageToken description A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. location query type string path v1alpha1/{+name}/locations response $ref ListLocationsResponse scopes https://www.googleapis.com/auth/cloud-platform resources applications methods create description Creates a new Application in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications httpMethod POST id runapps.projects.locations.applications.create parameterOrder parent parameters applicationId description Required. Id of the requesting object If auto-generating Id server-side, remove this field and application_id from the method_signature of Create RPC location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string requestId description An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string validateOnly description Optional. If set, validate the request, but do not actually persist it. location query type boolean path v1alpha1/{+parent}/applications request $ref Application response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId} httpMethod DELETE id runapps.projects.locations.applications.delete parameterOrder name parameters force description If set to true, any child deployments of this application will also be deleted. Followed the best practice from https://aip.dev/135#cascading-delete location query type boolean name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId} httpMethod GET id runapps.projects.locations.applications.get parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+name} response $ref Application scopes https://www.googleapis.com/auth/cloud-platform getStatus description Gets status of a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/status httpMethod GET id runapps.projects.locations.applications.getStatus parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string readMask description Field mask used for limiting the resources to query status on. format google-fieldmask location query type string resources description Optional. Specify which resource to query status for. If not provided, all resources status are queried. location query repeated True type string path v1alpha1/{+name}/status response $ref ApplicationStatus scopes https://www.googleapis.com/auth/cloud-platform list description Lists Applications in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications httpMethod GET id runapps.projects.locations.applications.list parameterOrder parent parameters filter description Filtering results location query type string orderBy description Hint for how to order the results location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListApplicationsRequest location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/applications response $ref ListApplicationsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId} httpMethod PATCH id runapps.projects.locations.applications.patch parameterOrder name parameters allowMissing description Optional. If set, a new Application will be created if it does not already exist. In this situation, `update_mask` is ignored. location query type boolean name description name of resource location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string requestId description An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string validateOnly description Optional. If set, validate the request, but do not actually persist it. location query type boolean path v1alpha1/{+name} request $ref Application response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform resources deployments methods create description Creates a new Deployment in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/deployments httpMethod POST id runapps.projects.locations.applications.deployments.create parameterOrder parent parameters deploymentId description Required. Id of the requesting object If auto-generating Id server-side, remove this field and deployment_id from the method_signature of Create RPC location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string requestId description An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string validateOnly description If true, the Create request will just do a dry run of the deploy instead of actuating anything. location query type boolean path v1alpha1/{+parent}/deployments request $ref Deployment response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Deployment. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/deployments/{deploymentsId} httpMethod GET id runapps.projects.locations.applications.deployments.get parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+/deployments/[^/]+$ required True type string path v1alpha1/{+name} response $ref Deployment scopes https://www.googleapis.com/auth/cloud-platform list description Lists Deployments in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/deployments httpMethod GET id runapps.projects.locations.applications.deployments.list parameterOrder parent parameters filter description Filtering results location query type string orderBy description Hint for how to order the results location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListDeploymentsRequest location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+parent}/deployments response $ref ListDeploymentsResponse scopes https://www.googleapis.com/auth/cloud-platform operations methods cancel description Starts 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`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel httpMethod POST id runapps.projects.locations.operations.cancel parameterOrder name parameters name description The name of the operation resource to be cancelled. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name}:cancel request $ref CancelOperationRequest response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes 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`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod DELETE id runapps.projects.locations.operations.delete parameterOrder name parameters name description The name of the operation resource to be deleted. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id runapps.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations httpMethod GET id runapps.projects.locations.operations.list parameterOrder name parameters filter description The standard list filter. location query type string name description The name of the operation's parent resource. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string pageSize description The standard list page size. format int32 location query type integer pageToken description The standard list page token. location query type string path v1alpha1/{+name}/operations response $ref ListOperationsResponse scopes https://www.googleapis.com/auth/cloud-platform revision 20250122 rootUrl https://runapps.googleapis.com/ schemas Application description Message describing Application object Next tag: 9 id Application properties annotations additionalProperties type string description Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. This field follows Kubernetes annotations' namespacing, limits, and rules. More info: http://kubernetes.io/docs/user-guide/annotations type object config $ref Config description The application configuration. On output, both intent repo and application config are populated. On input, only one can be modified at a time. createTime description Output only. Create time stamp format google-datetime readOnly True type string deleteTime description Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. format google-datetime readOnly True type string displayName description A mutable, user-defined name for the application. type string etag description Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. readOnly True type string labels additionalProperties type string description Labels as key value pairs type object name description name of resource type string reconciling description Output only. Indicates whether the resource's reconciliation is still in progress. readOnly True type boolean updateTime description Output only. Update time stamp format google-datetime readOnly True type string type object ApplicationStatus description Status of the application. id ApplicationStatus properties annotations additionalProperties type string description Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. This field follows Kubernetes annotations' namespacing, limits, and rules. More info: http://kubernetes.io/docs/user-guide/annotations type object createTime description Output only. Create time stamp format google-datetime readOnly True type string displayName description Display name type string etag description Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. readOnly True type string name description The resource name of the application status, in the following form: `projects/{project}/locations/{location}/applications/{application}/status` type string reconciling description Output only. Indicates whether the resource's reconciliation is still in progress. readOnly True type boolean resourceStatuses description Output only. The status of the resources in this application. items $ref ResourceStatus readOnly True type array resources additionalProperties $ref ResourceStatus deprecated True description The map of resource status where the key is the name of resources and the value is the resource status. Deprecated: use resource_statuses instead. type object updateTime description Output only. Time at which the status was last updated. format google-datetime readOnly True type string type object Binding description Binding describes the edge between the Resource it's defined in and the specified Resource. id Binding properties config additionalProperties description Properties of the object. type any description Configuration allows the caller to provide configurations that are either specific to the binding or clarify *how* the binding works. The configuration has an associated typekit-specified JSONSchema (https://json-schema.org/) that defines the expected shape. type object targetRef $ref ResourceRef description TargetRef describes the target resource. type object BindingStatus description The binding status of a resource id BindingStatus properties annotations additionalProperties type string description Annotations of the Cloud Run service for the binded resource. type object environmentVariables additionalProperties type string description Environment variables of the Cloud Run service for the binded resource. type object resourceName description Name of the binded resource. type string resourceType description Type of the binded resource. type string serviceAccount description Service account email used by the Cloud Run service for the binded resource. type string serviceName description Name of the Cloud Run service. type string type object CancelOperationRequest description The request message for Operations.CancelOperation. id CancelOperationRequest properties type object Config description Message for the Application Config Next tag: 6 id Config properties config description A byte array encapsulating the contents of the application config. This can be of any type of supported config (Simple Yaml, multi-file in-app config, etc.) format byte type string resourceList description Optional. The list of resources defined using the type-agnostic Resource definitions. items $ref Resource type array type object Deployment description Message describing Deployment object Next tag: 15 id Deployment properties annotations additionalProperties type string description Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. This field follows Kubernetes annotations' namespacing, limits, and rules. More info: http://kubernetes.io/docs/user-guide/annotations type object application description Output only. The name of the parent application. readOnly True type string createSelector $ref Selector description Optional selectors that should be applied to limit the scope of the deployment creation. createTime description Output only. Create time stamp format google-datetime readOnly True type string deleteSelector $ref Selector description Optional selectors that should be applied to limit the scope of the deployment deletion. deleteTime description Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. format google-datetime readOnly True type string etag description Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. readOnly True type string labels additionalProperties type string description Labels as key value pairs type object name description Output only. Canonical name of resource readOnly True type string reconciling description Output only. Indicates whether the resource's reconciliation is still in progress. readOnly True type boolean serviceAccount description Optional. The service account that will be used to actuate the deployment. type string status $ref DeploymentStatus description Output only. The status of the deployment readOnly True updateTime description Output only. Update time stamp format google-datetime readOnly True type string type object DeploymentOperationMetadata description Operation metadata for Deployment.Create. Next tag: 8 id DeploymentOperationMetadata properties apiVersion description The API version which triggered this operation. type string cancelRequested description Is cancelation requested for this operation. type boolean createTime description The time this operation was created. format google-datetime type string endTime description The time this operation ended or empty if it is still active. format google-datetime type string resourceStatus description The ongoinging state of resources that are being deployed. Order is not guaranteed to be stable between multiple reads of the same ongoing operation. items $ref ResourceDeploymentStatus type array target description Resource path for the target resource of the operation. type string verb description The verb associated with the API method which triggered this operation. type string type object DeploymentStatus description Message to encapsulate the current status of the deployment. id DeploymentStatus properties error $ref Status description Output only. Error status of the deployment if the deployment failed. The error.details field will contain the same information as the Deployment LRO error_details field in adherence to https://google.aip.dev/193. readOnly True errorMessage deprecated True description The error message associated with a failed deployment state, if applicable. type string jobDetails deprecated True description Details of each deploy job. items $ref JobDetails type array resourceStatus description The state of resources that are being deployed. Order is not guaranteed to be stable when deployment is in progress. items $ref ResourceDeploymentStatus type array state description The state associated with the deployment. enum STATE_UNSPECIFIED FAILED SUCCEEDED IN_PROGRESS enumDescriptions Default value. This value is unused. Deployment completed with failure. Deployment completed successfully. Deployment is running and has not completed. type string type object Empty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id Empty properties type object FirebaseHostingStatus description Detailed status for Firebase Hosting resource. id FirebaseHostingStatus properties domains description List of domains associated with the firebase hosting site. items type string type array hostingConfig description Hosting configuration created by Serverless Stacks. type string type object JobComponent deprecated True description Message to encapsulate component actuated by a job. JobComponent does not represent a GCP API resource. id JobComponent properties operation description Operation to be performed on component. enum COMPONENT_OPERATION_UNSPECIFIED APPLY DESTROY enumDescriptions ComponentOperation unset. Apply configuration to component. Destroy component. type string typedName $ref TypedName description TypedName is the component name and its type. type object JobDetails deprecated True description Message to encapsulate the current status deployment job. id JobDetails properties components description Components to be actuated by the job. items $ref JobComponent type array jobName description Name of deployment job. Format: projects/{project}/locations/{location}/builds/{build} type string jobUri description URI of deployment job within Google Cloud Console. type string state description State of deployment job. enum STATE_UNSPECIFIED FAILED SUCCEEDED IN_PROGRESS enumDescriptions Default value. This value is unused. Job completed with failure. Job completed successfully. Job is running and has not completed. type string type object ListApplicationsResponse description Message for response to listing Applications id ListApplicationsResponse properties applications description The list of Application items $ref Application type array nextPageToken description A token identifying a page of results the server should return. type string unreachable description Locations that could not be reached. items type string type array type object ListDeploymentsResponse description Message for response to listing Deployments id ListDeploymentsResponse properties deployments description The list of Deployment items $ref Deployment type array nextPageToken description A token identifying a page of results the server should return. type string unreachable description Locations that could not be reached. items type string type array type object ListLocationsResponse description The response message for Locations.ListLocations. id ListLocationsResponse properties locations description A list of locations that matches the specified filter in the request. items $ref Location type array nextPageToken description The standard List next-page token. type string type object ListOperationsResponse description The response message for Operations.ListOperations. id ListOperationsResponse properties nextPageToken description The standard List next-page token. type string operations description A list of operations that matches the specified filter in the request. items $ref Operation type array type object Location description A resource that represents a Google Cloud location. id Location properties displayName description The friendly name for this location, typically a nearby city name. For example, "Tokyo". type string labels additionalProperties type string description Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} type object locationId description The canonical id for this location. For example: `"us-east1"`. type string metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-specific metadata. For example the available capacity at the given location. type object name description Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` type string type object Operation description This resource represents a long-running operation that is the result of a network API call. id Operation properties done description If 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. type boolean error $ref Status description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object OperationMetadata description Represents the metadata of the long-running operation. id OperationMetadata properties apiVersion description API version used to start the operation. type string createTime description The time the operation was created. format google-datetime type string endTime description The time the operation finished running. format google-datetime type string requestedCancellation description Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. type boolean statusMessage description Human-readable status of the operation, if any. type string target description Server-defined resource path for the target of the operation. type string verb description Name of the verb executed by the operation. type string type object Resource description Resource defines a Stacks resource. Next tag: 8 id Resource properties bindings description Bindings describe the resources that this resource references. For Ingress Services, this includes Components. For Components, this includes Backing Services. For Backing Services, this is empty. items $ref Binding type array config additionalProperties description Properties of the object. type any description Configuration is the typekit-specified set of fields that define the resource. The configuration has an associated typekit-specified JSONSchema (https://json-schema.org/) that defines the expected shape. type object id $ref ResourceID description Resource ID describes the resource that's bound. latestDeployment description Output only. The deployment name for the most recent deployment that has been triggered for a given resource. If a resource was never deployed then this field will be empty. readOnly True type string subresources description Subresources is the set of subresources within this resource. Support for this field depends on the type of the Resource and is defined by the corresponding Typekit. items $ref Resource type array type object ResourceComponentStatus description Status for a component of a resource. id ResourceComponentStatus properties consoleLink description Pantheon link for the resource. This does not exist for every resource that makes up the SAF resource. type string diverged description Indicates that this resource component has been altered and may not match the expected state. type boolean name description The name the resource component. Usually it's the name of the GCP resource, which was used inside the Terraform Resource block that defines it. (e.g. cri-domain-cert) type string reason description The reason why this resource component to be in its state. type string selfLink description Fully qualified URL to the object represented by this resource component. type string state description The state of the resource component. enum STATE_UNSPECIFIED DEPLOYED MISSING PROVISIONING ACTIVE FAILED enumDescriptions The status of this component is unspecified. The component has been deployed. The component is missing. The component has been deployed and is provisioning. The component has been deployed and is working as intended. This is intended for resources that have a health indicator. The component has failed and the full error message will be populated in the resource. type string type description The Terraform Resource Type of the GCP resource (e.g. "google_compute_managed_ssl_certificate"). type string type object ResourceDeploymentError description Message describing the error that occurred for the respective resource. id ResourceDeploymentError properties errorMessage description Output only. Error details provided by deployment. readOnly True type string httpCode description Output only. HTTP error code provided by the deployment. format int32 readOnly True type integer type object ResourceDeploymentStatus description Message decribing the status of a resource being deployed. Next tag: 7 id ResourceDeploymentStatus properties errorMessage deprecated True description The error details if the state is FAILED. type string errors description Output only. The error details if the state is FAILED. items $ref ResourceDeploymentError readOnly True type array id $ref ResourceID description Output only. ID of the resource. readOnly True name $ref TypedName deprecated True description Name of the resource. operation description Operation to be performed on the resource . enum OPERATION_UNSPECIFIED APPLY DESTROY enumDescriptions Default value indicating the operation is unknown. Apply configuration to resource. Destroy resource. type string state description Current status of the resource. enum STATE_UNSPECIFIED NOT_STARTED RUNNING FINISHED SUCCEEDED FAILED enumDeprecated False False False True False False enumDescriptions Default value indicating the state is unknown. Resource queued for deployment. Deployment in progress. Deployment completed. Deployment completed successfully. Deployment completed with failure. type string type object ResourceID description ResourceID encapsulates the definition of the identity of a resource. id ResourceID properties name description Name is the name of the resource. This name must be unique within the type. type string type description Type is the name of the resource. type string type object ResourceRef description ResourceRef encapsulates the definition of a reference to another resource. id ResourceRef properties id $ref ResourceID description The ID of another resource specified in the config. type object ResourceStatus description Status for a resource. id ResourceStatus properties bindingStatus deprecated True description The binding status related to this resource. Deprecated: it's not implemented. items $ref BindingStatus type array consoleLink description Pantheon link for the resource. For example, the custom domain will link to the GCLB page. type string diverged deprecated True description Indicates that a child component of this resource has been altered and may not match the expected state. Deprecated: it's not implemented. type boolean extraDetails additionalProperties description Properties of the object. type any description Extra details of the resource that are needed for the users to make use of the resources, such as IP Address of GCLB. type object firebaseHostingDetails $ref FirebaseHostingStatus deprecated True description Details for Firebase Hosting resource. Deprecated: use extra_details instead. id $ref ResourceID description ID of the resource. reason description The reason why this resource is in the current state. type string resourceComponentStatuses description Repeated field with status per component created for this resource. items $ref ResourceComponentStatus type array resourceName deprecated True description Name of the resource, pulled from the Application Config. Deprecated: use the id field instead. type string routerDetails $ref RouterStatus deprecated True description Detail Status of Router resource. Deprecated: use extra_details instead. state description The enum state of the resource. enum STATE_UNSPECIFIED ACTIVE FAILED MISSING UPDATING NOT_READY NOT_DEPLOYED enumDescriptions The status of this resource is unspecified. The resource is active. Some of the components of the resource are not working. The key components are missing after at least one successful deployment. The user could have manually removed a resource that was deployed. The resource is being deployed. Some of the resource's child resources are not in ready state. The resource is currently not deployed. This could happen if the resource was added to the application config, but was not deployed yet, or the resource was undeployed. type string type deprecated True description Type of resource. Deprecated: use the id field instead. type string type object RouterStatus description Detail Status of Router resource. id RouterStatus properties ipAddress description IP Address of the Google Cloud Load Balancer. type string type object Selector description Message for selecting the resources within an application. Next tag: 4 id Selector properties matchTypeNames description match_type_names is a list resource name + type to match. Use '*' or empty string for wildcard either the name or the type. E.g. type='service' name='' will match all services. type='*' name='default' will match all resources named as 'default'. items $ref TypedName type array type object Status description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id Status properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object TypedName description TypedName is a resource name + its type. Next tag: 4 id TypedName properties ignoreResourceConfig description Optional. If true, the config associated with the resource will not be applied, and the underlying live object config will be retained. If false (or unset), the set config will be applied. If the resource does not already exist, this flag will be ignored. This option is only supported for certain types. This field is only supported when provided as part of the selector. type boolean name description The name of the resource. type string type description The type of the resource. type string type object servicePath title Serverless Integrations API version v1alpha1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/safebrowsing-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/safebrowsing-v4	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/safebrowsing-v5	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/safebrowsing-v5alpha1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/sasportal-	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/sasportal-v1	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/sasportal-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/searchconsole-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/searchconsole-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/secretmanager-	values_changed root['revision'] new_value 20250130 old_value 20250117 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://secretmanager.europe-north2.rep.googleapis.com/ location europe-north2
prod/secretmanager-v1	values_changed root['revision'] new_value 20250130 old_value 20250117 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://secretmanager.europe-north2.rep.googleapis.com/ location europe-north2
prod/secretmanager-v1beta1	values_changed root['revision'] new_value 20250130 old_value 20250117 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://secretmanager.europe-north2.rep.googleapis.com/ location europe-north2
prod/secretmanager-v1beta2	values_changed root['revision'] new_value 20250130 old_value 20250117 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://secretmanager.europe-north2.rep.googleapis.com/ location europe-north2
prod/servicecontrol-	values_changed root['revision'] new_value 20250131 old_value 20250124
prod/servicecontrol-v1	values_changed root['revision'] new_value 20250131 old_value 20250124
prod/servicecontrol-v2	values_changed root['revision'] new_value 20250131 old_value 20250124
prod/servicedirectory-	values_changed root['revision'] new_value 20250130 old_value 20250120
prod/servicedirectory-v1	values_changed root['revision'] new_value 20250130 old_value 20250120
prod/servicedirectory-v1beta1	values_changed root['revision'] new_value 20250130 old_value 20250120
prod/servicenetworking-	dictionary_item_added root['schemas']['Aspect'] root['schemas']['Service']['properties']['aspects'] values_changed root['revision'] new_value 20250204 old_value 20250203
prod/servicenetworking-v1	dictionary_item_added root['schemas']['Aspect'] root['schemas']['Service']['properties']['aspects'] values_changed root['revision'] new_value 20250204 old_value 20250203
prod/servicenetworking-v1beta	dictionary_item_added root['schemas']['Aspect'] root['schemas']['Service']['properties']['aspects'] values_changed root['revision'] new_value 20250204 old_value 20250203
prod/sheets-	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/sheets-v1	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/sheets-v4	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/solar-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/solar-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/southamerica-east1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-artifactregistry-v1	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/southamerica-east1-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-east1-cloudbuild-	values_changed root['resources']['projects']['resources']['locations']['resources']['connections']['methods']['processWebhook']['parameters']['webhookKey']['description'] new_value Arbitrary additional key to find the matching repository for a webhook event if needed. old_value Arbitrary additional key to find the maching repository for a webhook event if needed. root['revision'] new_value 20250129 old_value 20250117
prod/southamerica-east1-cloudbuild-v1	values_changed root['revision'] new_value 20250129 old_value 20250117
prod/southamerica-east1-cloudbuild-v2	values_changed root['resources']['projects']['resources']['locations']['resources']['connections']['methods']['processWebhook']['parameters']['webhookKey']['description'] new_value Arbitrary additional key to find the matching repository for a webhook event if needed. old_value Arbitrary additional key to find the maching repository for a webhook event if needed. root['revision'] new_value 20250129 old_value 20250117
prod/southamerica-east1-connectgateway-	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/southamerica-east1-connectgateway-v1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/southamerica-east1-connectgateway-v1beta1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/southamerica-east1-gkemulticloud-	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/southamerica-east1-gkemulticloud-v1	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/southamerica-east1-monitoring-	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/southamerica-east1-monitoring-v1	dictionary_item_removed root['schemas']['PieChartDataSet']['properties']['breakdowns'] values_changed root['revision'] new_value 20250127 old_value 20250120
prod/southamerica-east1-monitoring-v3	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/southamerica-east1-pubsub-	values_changed root['revision'] new_value 20250128 old_value 20250123
prod/southamerica-east1-pubsub-v1	dictionary_item_added root['schemas']['JavaScriptUDF'] root['schemas']['MessageTransform'] root['schemas']['Subscription']['properties']['messageTransforms'] root['schemas']['Topic']['properties']['messageTransforms'] values_changed root['revision'] new_value 20250128 old_value 20250123
prod/southamerica-east1-pubsub-v1beta2	values_changed root['revision'] new_value 20250128 old_value 20250123
prod/southamerica-east1-workflowexecutions-	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/southamerica-east1-workflowexecutions-v1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/southamerica-east1-workflowexecutions-v1alpha1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/southamerica-east1-workflowexecutions-v1beta	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/southamerica-west1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/southamerica-west1-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/spectrumsas-pa-	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/spectrumsas-pa-v1	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/spectrumsas-pa-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/staging-deploymentmanager.sandbox-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/staging-deploymentmanager.sandbox-alpha	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/staging-deploymentmanager.sandbox-dogfood	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/staging-deploymentmanager.sandbox-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/staging-deploymentmanager.sandbox-v2	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/staging-deploymentmanager.sandbox-v2beta	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/storageinsights-	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/storageinsights-v1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://storageinsights.googleapis.com/ batchPath batch canonicalName Storage Insights description Provides insights capability on Google Cloud Storage discoveryVersion v1 documentationLink https://cloud.google.com/storage/docs/metadata fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id storageinsights:v1 kind discovery#restDescription mtlsRootUrl https://storageinsights.mtls.googleapis.com/ name storageinsights ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations methods get description Gets information about a location. flatPath v1/projects/{projectsId}/locations/{locationsId} httpMethod GET id storageinsights.projects.locations.get parameterOrder name parameters name description Resource name for the location. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+name} response $ref Location scopes https://www.googleapis.com/auth/cloud-platform list description Lists information about the supported locations for this service. flatPath v1/projects/{projectsId}/locations httpMethod GET id storageinsights.projects.locations.list parameterOrder name parameters filter description A 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). location query type string name description The resource that owns the locations collection, if applicable. location path pattern ^projects/[^/]+$ required True type string pageSize description The maximum number of results to return. If not set, the service selects a default. format int32 location query type integer pageToken description A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. location query type string path v1/{+name}/locations response $ref ListLocationsResponse scopes https://www.googleapis.com/auth/cloud-platform resources datasetConfigs methods create description Creates a new DatasetConfig in a given project and location. flatPath v1/projects/{projectsId}/locations/{locationsId}/datasetConfigs httpMethod POST id storageinsights.projects.locations.datasetConfigs.create parameterOrder parent parameters datasetConfigId description Required. Id of the requesting object If auto-generating Id server-side, remove this field and dataset_config_id from the method_signature of Create RPC Note: The value should not contain any hyphens. location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1/{+parent}/datasetConfigs request $ref DatasetConfig response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single DatasetConfig. flatPath v1/projects/{projectsId}/locations/{locationsId}/datasetConfigs/{datasetConfigsId} httpMethod DELETE id storageinsights.projects.locations.datasetConfigs.delete parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/datasetConfigs/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single DatasetConfig. flatPath v1/projects/{projectsId}/locations/{locationsId}/datasetConfigs/{datasetConfigsId} httpMethod GET id storageinsights.projects.locations.datasetConfigs.get parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/datasetConfigs/[^/]+$ required True type string path v1/{+name} response $ref DatasetConfig scopes https://www.googleapis.com/auth/cloud-platform linkDataset description Creates a linked dataset for the given DatasetConfig. flatPath v1/projects/{projectsId}/locations/{locationsId}/datasetConfigs/{datasetConfigsId}:linkDataset httpMethod POST id storageinsights.projects.locations.datasetConfigs.linkDataset parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/datasetConfigs/[^/]+$ required True type string path v1/{+name}:linkDataset request $ref LinkDatasetRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists DatasetConfigs in a given project and location. flatPath v1/projects/{projectsId}/locations/{locationsId}/datasetConfigs httpMethod GET id storageinsights.projects.locations.datasetConfigs.list parameterOrder parent parameters filter description Filtering results location query type string orderBy description Hint for how to order the results location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListDatasetConfigsRequest location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+parent}/datasetConfigs response $ref ListDatasetConfigsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single DatasetConfig. flatPath v1/projects/{projectsId}/locations/{locationsId}/datasetConfigs/{datasetConfigsId} httpMethod PATCH id storageinsights.projects.locations.datasetConfigs.patch parameterOrder name parameters name description Identifier. name of resource location path pattern ^projects/[^/]+/locations/[^/]+/datasetConfigs/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the DatasetConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then it will lead to "Invalid Argument" error as providing update_mask is mandatory. format google-fieldmask location query type string path v1/{+name} request $ref DatasetConfig response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform unlinkDataset description Deletes/unsubscribes the linked dataset of the given DatasetConfig. flatPath v1/projects/{projectsId}/locations/{locationsId}/datasetConfigs/{datasetConfigsId}:unlinkDataset httpMethod POST id storageinsights.projects.locations.datasetConfigs.unlinkDataset parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/datasetConfigs/[^/]+$ required True type string path v1/{+name}:unlinkDataset request $ref UnlinkDatasetRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform operations methods cancel description Starts 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`. flatPath v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel httpMethod POST id storageinsights.projects.locations.operations.cancel parameterOrder name parameters name description The name of the operation resource to be cancelled. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1/{+name}:cancel request $ref CancelOperationRequest response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes 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`. flatPath v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod DELETE id storageinsights.projects.locations.operations.delete parameterOrder name parameters name description The name of the operation resource to be deleted. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets 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. flatPath v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id storageinsights.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. flatPath v1/projects/{projectsId}/locations/{locationsId}/operations httpMethod GET id storageinsights.projects.locations.operations.list parameterOrder name parameters filter description The standard list filter. location query type string name description The name of the operation's parent resource. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string pageSize description The standard list page size. format int32 location query type integer pageToken description The standard list page token. location query type string path v1/{+name}/operations response $ref ListOperationsResponse scopes https://www.googleapis.com/auth/cloud-platform reportConfigs methods create description Creates a new ReportConfig in a given project and location. flatPath v1/projects/{projectsId}/locations/{locationsId}/reportConfigs httpMethod POST id storageinsights.projects.locations.reportConfigs.create parameterOrder parent parameters parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1/{+parent}/reportConfigs request $ref ReportConfig response $ref ReportConfig scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single ReportConfig. flatPath v1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId} httpMethod DELETE id storageinsights.projects.locations.reportConfigs.delete parameterOrder name parameters force description Optional. If set, all ReportDetails for this ReportConfig will be deleted. location query type boolean name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/reportConfigs/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single ReportConfig. flatPath v1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId} httpMethod GET id storageinsights.projects.locations.reportConfigs.get parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/reportConfigs/[^/]+$ required True type string path v1/{+name} response $ref ReportConfig scopes https://www.googleapis.com/auth/cloud-platform list description Lists ReportConfigs in a given project and location. flatPath v1/projects/{projectsId}/locations/{locationsId}/reportConfigs httpMethod GET id storageinsights.projects.locations.reportConfigs.list parameterOrder parent parameters filter description Filtering results location query type string orderBy description Hint for how to order the results location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListReportConfigsRequest location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1/{+parent}/reportConfigs response $ref ListReportConfigsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single ReportConfig. flatPath v1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId} httpMethod PATCH id storageinsights.projects.locations.reportConfigs.patch parameterOrder name parameters name description Identifier. name of resource. It will be of form projects//locations//reportConfigs/. location path pattern ^projects/[^/]+/locations/[^/]+/reportConfigs/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the ReportConfig resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then it will lead to "Invalid Argument" error as providing update_mask is mandatory. format google-fieldmask location query type string path v1/{+name} request $ref ReportConfig response $ref ReportConfig scopes https://www.googleapis.com/auth/cloud-platform resources reportDetails methods get description Gets details of a single ReportDetail. flatPath v1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId}/reportDetails/{reportDetailsId} httpMethod GET id storageinsights.projects.locations.reportConfigs.reportDetails.get parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/reportConfigs/[^/]+/reportDetails/[^/]+$ required True type string path v1/{+name} response $ref ReportDetail scopes https://www.googleapis.com/auth/cloud-platform list description Lists ReportDetails in a given project and location. flatPath v1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId}/reportDetails httpMethod GET id storageinsights.projects.locations.reportConfigs.reportDetails.list parameterOrder parent parameters filter description Filtering results location query type string orderBy description Hint for how to order the results location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListReportDetailsRequest location path pattern ^projects/[^/]+/locations/[^/]+/reportConfigs/[^/]+$ required True type string path v1/{+parent}/reportDetails response $ref ListReportDetailsResponse scopes https://www.googleapis.com/auth/cloud-platform revision 20250129 rootUrl https://storageinsights.googleapis.com/ schemas BucketErrors description Provides a summary of the bucket level error stats. id BucketErrors properties internalErrorCount description Optional. Buckets that were not validated due to internal errors and will be automatically retried. format int64 type string nonManagementHubEntitledBucketIds description Optional. Subset of bucket names which are not Management Hub entitled. items type string type array nonManagementHubEntitledCount description Optional. Count of buckets which are not Management Hub entitled. format int64 type string permissionDeniedBucketIds description Optional. Subset of bucket names that have permission denied. items type string type array permissionDeniedCount description Optional. Count of buckets with permission denied errors. format int64 type string validatedCount description Optional. Count of successfully validated buckets. format int64 type string type object CSVOptions description Options to configure CSV formatted reports. id CSVOptions properties delimiter description Delimiter characters in CSV. type string headerRequired description If set, will include a header row in the CSV report. type boolean recordSeparator description Record separator characters in CSV. type string type object CancelOperationRequest description The request message for Operations.CancelOperation. id CancelOperationRequest properties type object CloudStorageBucket description Defines the bucket by its name or a regex pattern to match buckets. Next ID: 3 id CloudStorageBucket properties bucketName description Cloud Storage bucket name. type string bucketPrefixRegex description A regex pattern for bucket names matching the regex. Regex should follow the syntax specified in google/re2 on GitHub. type string type object CloudStorageBuckets description Collection of Cloud Storage buckets. Next ID: 2 id CloudStorageBuckets properties cloudStorageBuckets items $ref CloudStorageBucket type array type object CloudStorageDestinationOptions description Options to store reports in storage systems. Next ID: 3 id CloudStorageDestinationOptions properties bucket description Optional. Destination bucket. type string destinationPath description Destination path is the path in the bucket where the report should be generated. type string type object CloudStorageFilters description Options to filter data on storage systems. Next ID: 2 id CloudStorageFilters properties bucket description Optional. Bucket for which the report will be generated. type string type object CloudStorageLocations description Collection of Cloud Storage locations. Next ID: 2 id CloudStorageLocations properties locations items type string type array type object DatasetConfig description Message describing DatasetConfig object which defines the following key aspects 1. Scope of metadata ingestion - a.k.a. buckets on which bucket and object metadata will be ingested. 2. Retention period - how long will the data be stored in BigQuery since customers pay for it. 3. Linked dataset name 4. Identity that will be used to ingest metadata. id DatasetConfig properties cloudStorageObjectPath description Input only. Cloud Storage object path containing a list of project or folder numbers to include in the dataset; it cannot contain a mix of project and folders. The object must be a TXT file where each line has one of the following entries: - Project number, for example, `projects/{project_number}`, for example, `projects/1234567890`. - Folder identifier in the format `folders/{folder_number}`, for example, `folders/9876543210`. Path must be in the format `gs://{bucket_name}/{object_name}`. type string createTime description Output only. [Output only] Create time stamp format google-datetime readOnly True type string datasetConfigState description Output only. State of the DatasetConfig. enum CONFIG_STATE_UNSPECIFIED CONFIG_STATE_ACTIVE CONFIG_STATE_VERIFICATION_IN_PROGRESS CONFIG_STATE_CREATED CONFIG_STATE_PROCESSING enumDescriptions Unspecified state. Active configuration indicates that the configuration is actively ingesting data. In this state, the configuration is being verified for various permissions. Configuration is created and further processing needs to happen. Configuration is under processing readOnly True type string description description Optional. User provided description for the dataset config. Limited to 256 characters. type string excludeCloudStorageBuckets $ref CloudStorageBuckets excludeCloudStorageLocations $ref CloudStorageLocations identity $ref Identity description Identity in use by this datasetConfig. includeCloudStorageBuckets $ref CloudStorageBuckets includeCloudStorageLocations $ref CloudStorageLocations includeNewlyCreatedBuckets description When true, will include all newly created buckets in the dataset that meets the inclusion and exclusion rules. type boolean labels additionalProperties type string description Labels as key value pairs type object link $ref Link description Details of the linked dataset. name description Identifier. name of resource type string organizationNumber description Optional. Organization number that the source projects should belong to. Projects that do not belong to the provided organization will not be considered when creating the dataset. format int64 type string organizationScope description Defines the options for providing a source organization for the dataset. type boolean retentionPeriodDays description # of days of history that need to be retained. format int32 type integer skipVerificationAndIngest deprecated True description Optional. If false, then all permission checks should be successful before the configuration is ready for first ingestion. This field can only be updated before the first ingestion updating the field after first ingestion will cause an error. type boolean sourceFolders $ref SourceFolders description Defines the options for providing source folders for the dataset. sourceProjects $ref SourceProjects description Defines the options for providing source projects for the dataset. status $ref Status description Output only. Status of the DatasetConfig. readOnly True uid description Output only. System generated unique identifier for the resource. readOnly True type string updateTime description Output only. [Output only] Update time stamp format google-datetime readOnly True type string type object Date description Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp id Date properties day description Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. format int32 type integer month description Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. format int32 type integer year description Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. format int32 type integer type object DateTime description Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. id DateTime properties day description Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. format int32 type integer hours description Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. format int32 type integer minutes description Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. format int32 type integer month description Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. format int32 type integer nanos description Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. format int32 type integer seconds description Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. format int32 type integer timeZone $ref TimeZone description Time zone. utcOffset description UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. format google-duration type string year description Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. format int32 type integer type object Empty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id Empty properties type object FrequencyOptions description ReportConfig Resource: Options to setup frequency of report generation. id FrequencyOptions properties endDate $ref Date description The date on which report generation should stop (Inclusive). UTC time zone. frequency description Frequency of report generation. enum FREQUENCY_UNSPECIFIED DAILY WEEKLY enumDescriptions Unspecified. Report will be generated daily. Report will be generated weekly. type string startDate $ref Date description The date from which report generation should start. UTC time zone. type object Identity description Identity lets the user provide the type of identity to use, and outputs the identity string that can be used for IAM policy changes. id Identity properties name description Output only. Name of the identity. readOnly True type string type description Type of identity to use for the datasetConfig. enum IDENTITY_TYPE_UNSPECIFIED IDENTITY_TYPE_PER_CONFIG IDENTITY_TYPE_PER_PROJECT enumDescriptions Default is unspecified and should not be used. Google managed service account per resource. Google managed service account per project. type string type object Link description Link defines the details about the linked dataset. Next ID: 3 id Link properties dataset description Output only. Dataset name for linked dataset. readOnly True type string linked description Output only. State of the linked dataset. readOnly True type boolean type object LinkDatasetRequest description Message for creating a linked dataset. id LinkDatasetRequest properties type object ListDatasetConfigsResponse description Message for response to listing DatasetConfigs. id ListDatasetConfigsResponse properties datasetConfigs description The list of DatasetConfig items $ref DatasetConfig type array nextPageToken description A token identifying a page of results the server should return. type string unreachable description Locations that could not be reached. items type string type array type object ListLocationsResponse description The response message for Locations.ListLocations. id ListLocationsResponse properties locations description A list of locations that matches the specified filter in the request. items $ref Location type array nextPageToken description The standard List next-page token. type string type object ListOperationsResponse description The response message for Operations.ListOperations. id ListOperationsResponse properties nextPageToken description The standard List next-page token. type string operations description A list of operations that matches the specified filter in the request. items $ref Operation type array type object ListReportConfigsResponse description Message for response to listing ReportConfigs id ListReportConfigsResponse properties nextPageToken description A token identifying a page of results the server should return. type string reportConfigs description The list of ReportConfig items $ref ReportConfig type array unreachable description Locations that could not be reached. items type string type array type object ListReportDetailsResponse description Message for response to listing ReportDetails id ListReportDetailsResponse properties nextPageToken description A token identifying a page of results the server should return. type string reportDetails description The list of ReportDetail items $ref ReportDetail type array unreachable description Locations that could not be reached. items type string type array type object Location description A resource that represents a Google Cloud location. id Location properties displayName description The friendly name for this location, typically a nearby city name. For example, "Tokyo". type string labels additionalProperties type string description Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} type object locationId description The canonical id for this location. For example: `"us-east1"`. type string metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-specific metadata. For example the available capacity at the given location. type object name description Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` type string type object LocationMetadata description Metadata that helps discover which resources are available in a location. Next Id: 3 id LocationMetadata properties datasetConfigAvailable description If true, storageinsights.googleapis.com/DatasetConfig resource is available at the location. type boolean reportConfigAvailable description If true, storageinsights.googleapis.com/ReportConfig resource is available at the location. type boolean type object Metrics description Different metrics associated with the generated report. id Metrics properties processedRecordsCount description Count of Cloud Storage objects which are part of the report. format int64 type string type object ObjectMetadataReportOptions description Report specification for exporting object metadata. Next ID: 4 id ObjectMetadataReportOptions properties metadataFields description Metadata fields to be included in the report. items type string type array storageDestinationOptions $ref CloudStorageDestinationOptions description Cloud Storage as the storage system. storageFilters $ref CloudStorageFilters description Cloud Storage as the storage system. type object Operation description This resource represents a long-running operation that is the result of a network API call. id Operation properties done description If 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. type boolean error $ref Status description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object OperationMetadata description Represents the metadata of the long-running operation. id OperationMetadata properties apiVersion description Output only. API version used to start the operation. readOnly True type string createTime description Output only. The time the operation was created. format google-datetime readOnly True type string endTime description Output only. The time the operation finished running. format google-datetime readOnly True type string requestedCancellation description Output 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`. readOnly True type boolean statusMessage description Output only. Human-readable status of the operation, if any. readOnly True type string target description Output only. Server-defined resource path for the target of the operation. readOnly True type string verb description Output only. Name of the verb executed by the operation. readOnly True type string type object ParquetOptions description Options to configure Parquet formatted reports. id ParquetOptions properties type object ProjectErrors description Provides a summary of the project level error stats. id ProjectErrors properties destinationProjectCheckHasInternalError description Optional. Whether the destination project check failed due to an internal error. This will be automatically retried. type boolean destinationProjectOrgError description Optional. Whether the destination project is in the same organization. type boolean internalErrorCount description Optional. Projects that were not validated for internal errors and will be automatically retried. format int64 type string nonManagementHubEntitledErrorCount description Optional. Count of projects which are not Management Hub entitled. format int64 type string nonManagementHubEntitledProjectNumbers description Optional. Subset of project numbers which are not Management Hub entitled. items format int64 type string type array outsideOrgErrorCount description Optional. Count of projects which are not in the same organization. format int64 type string outsideOrgProjectNumbers description Optional. Subset of project numbers which are not in the same organization. items format int64 type string type array validatedCount description Optional. Count of successfully validated projects. format int64 type string type object ReportConfig description Message describing ReportConfig object. ReportConfig is the configuration to generate reports. See https://cloud.google.com/storage/docs/insights/using-inventory-reports#create-config-rest for more details on how to set various fields. Next ID: 12 id ReportConfig properties createTime description Output only. [Output only] Create time stamp format google-datetime readOnly True type string csvOptions $ref CSVOptions description Options for CSV formatted reports. displayName description User provided display name which can be empty and limited to 256 characters that is editable. type string frequencyOptions $ref FrequencyOptions description The frequency of report generation. labels additionalProperties type string description Labels as key value pairs type object name description Identifier. name of resource. It will be of form projects//locations//reportConfigs/. type string objectMetadataReportOptions $ref ObjectMetadataReportOptions description Report for exporting object metadata. parquetOptions $ref ParquetOptions description Options for Parquet formatted reports. updateTime description Output only. [Output only] Update time stamp format google-datetime readOnly True type string type object ReportDetail description Message describing ReportDetail object. ReportDetail represents metadata of generated reports for a ReportConfig. Next ID: 11 id ReportDetail properties labels additionalProperties type string description Labels as key value pairs type object name description Name of resource. It will be of form projects//locations//reportConfigs//reportDetails/. type string reportMetrics $ref Metrics description Metrics of the report. reportPathPrefix description Prefix of the object name of each report's shard. This will have full prefix except the "extension" and "shard_id". For example, if the `destination_path` is `{{report-config-id}}/dt={{datetime}}`, the shard object name would be `gs://my-insights/1A34-F2E456-12B456-1C3D/dt=2022-05-20T06:35/1A34-F2E456-12B456-1C3D_2022-05-20T06:35_5.csv` and the value of `report_path_prefix` field would be `gs://my-insights/1A34-F2E456-12B456-1C3D/dt=2022-05-20T06:35/1A34-F2E456-12B456-1C3D_2022-05-20T06:35_`. type string shardsCount description Total shards generated for the report. format int64 type string snapshotTime description The snapshot time. All the report data is referenced at this point of time. format google-datetime type string status $ref Status description Status of the ReportDetail. targetDatetime $ref DateTime description The date for which report is generated. The time part of target_datetime will be zero till we support multiple reports per day. type object ReportStatsView description Message to encapsulate the various statistics related to the generated Report Next ID: 6 id ReportStatsView properties bytesWritten description Actual size in bytes for the report written, as reported by the underlying storage system format int64 type string projectNumber description Project Number format int64 type string recordsProcessed description Actual records processed as reported by the underlying storage system format int64 type string reportConfigId description ID of the parent ReportConfig for the corresponding ReportDetail type string reportDetailId description ID of the ReportDetail for which the stats are generated type string type object SourceFolders description Specifies a set of folders to include in the dataset id SourceFolders properties folderNumbers description Optional. The list of folder numbers to include in the dataset. items format int64 type string type array type object SourceProjects description Collection of project numbers Next ID: 2 id SourceProjects properties projectNumbers items format int64 type string type array type object Status description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id Status properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object TimeZone description Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). id TimeZone properties id description IANA Time Zone Database time zone. For example "America/New_York". type string version description Optional. IANA Time Zone Database version number. For example "2019a". type string type object UnlinkDatasetRequest description Message for unlinking/unsbscribe from the linked dataset. id UnlinkDatasetRequest properties type object ValidationErrorsBeforeIngestion description Summary of validation errors that occurred during the Verification phase. Next ID: 3 id ValidationErrorsBeforeIngestion properties bucketErrors $ref BucketErrors description Optional. Provides a summary of the bucket level error stats. projectErrors $ref ProjectErrors description Optional. Provides a summary of the project level error stats. type object servicePath title Storage Insights API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/storagetransfer-	values_changed root['revision'] new_value 20250131 old_value 20250125
prod/storagetransfer-v1	values_changed root['revision'] new_value 20250131 old_value 20250125
prod/stream-	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://stream.googleapis.com/ batchPath batch canonicalName Stream description discoveryVersion v1 documentationLink https://cloud.google.com fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id stream:v1beta kind discovery#restDescription mtlsRootUrl https://stream.mtls.googleapis.com/ name stream ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations methods get description Gets information about a location. flatPath v1beta/projects/{projectsId}/locations/{locationsId} httpMethod GET id stream.projects.locations.get parameterOrder name parameters name description Resource name for the location. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1beta/{+name} response $ref Location scopes https://www.googleapis.com/auth/cloud-platform list description Lists information about the supported locations for this service. flatPath v1beta/projects/{projectsId}/locations httpMethod GET id stream.projects.locations.list parameterOrder name parameters filter description A 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). location query type string name description The resource that owns the locations collection, if applicable. location path pattern ^projects/[^/]+$ required True type string pageSize description The maximum number of results to return. If not set, the service selects a default. format int32 location query type integer pageToken description A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. location query type string path v1beta/{+name}/locations response $ref ListLocationsResponse scopes https://www.googleapis.com/auth/cloud-platform resources operations methods cancel description Starts 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`. flatPath v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel httpMethod POST id stream.projects.locations.operations.cancel parameterOrder name parameters name description The name of the operation resource to be cancelled. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1beta/{+name}:cancel request $ref CancelOperationRequest response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes 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`. flatPath v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod DELETE id stream.projects.locations.operations.delete parameterOrder name parameters name description The name of the operation resource to be deleted. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1beta/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets 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. flatPath v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id stream.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1beta/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. flatPath v1beta/projects/{projectsId}/locations/{locationsId}/operations httpMethod GET id stream.projects.locations.operations.list parameterOrder name parameters filter description The standard list filter. location query type string name description The name of the operation's parent resource. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string pageSize description The standard list page size. format int32 location query type integer pageToken description The standard list page token. location query type string path v1beta/{+name}/operations response $ref ListOperationsResponse scopes https://www.googleapis.com/auth/cloud-platform revision 20241106 rootUrl https://stream.googleapis.com/ schemas CancelOperationRequest description The request message for Operations.CancelOperation. id CancelOperationRequest properties type object Empty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id Empty properties type object ListLocationsResponse description The response message for Locations.ListLocations. id ListLocationsResponse properties locations description A list of locations that matches the specified filter in the request. items $ref Location type array nextPageToken description The standard List next-page token. type string type object ListOperationsResponse description The response message for Operations.ListOperations. id ListOperationsResponse properties nextPageToken description The standard List next-page token. type string operations description A list of operations that matches the specified filter in the request. items $ref Operation type array type object Location description A resource that represents a Google Cloud location. id Location properties displayName description The friendly name for this location, typically a nearby city name. For example, "Tokyo". type string labels additionalProperties type string description Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} type object locationId description The canonical id for this location. For example: `"us-east1"`. type string metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-specific metadata. For example the available capacity at the given location. type object name description Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` type string type object Operation description This resource represents a long-running operation that is the result of a network API call. id Operation properties done description If 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. type boolean error $ref Status description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object OperationMetadata description Represents the metadata of the long-running operation. id OperationMetadata properties apiVersion description Output only. API version used to start the operation. readOnly True type string createTime description Output only. The time the operation was created. format google-datetime readOnly True type string endTime description Output only. The time the operation finished running. format google-datetime readOnly True type string requestedCancellation description Output 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`. readOnly True type boolean statusMessage description Output only. Human-readable status of the operation, if any. readOnly True type string target description Output only. Server-defined resource path for the target of the operation. readOnly True type string verb description Output only. Name of the verb executed by the operation. readOnly True type string type object Status description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id Status properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object servicePath title Immersive Stream for XR API version v1beta version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/stream-v1alpha1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://stream.googleapis.com/ batchPath batch canonicalName Stream description discoveryVersion v1 documentationLink https://cloud.google.com fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id stream:v1alpha1 kind discovery#restDescription mtlsRootUrl https://stream.mtls.googleapis.com/ name stream ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations methods get description Gets information about a location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId} httpMethod GET id stream.projects.locations.get parameterOrder name parameters name description Resource name for the location. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Location scopes https://www.googleapis.com/auth/cloud-platform list description Lists information about the supported locations for this service. flatPath v1alpha1/projects/{projectsId}/locations httpMethod GET id stream.projects.locations.list parameterOrder name parameters filter description A 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). location query type string name description The resource that owns the locations collection, if applicable. location path pattern ^projects/[^/]+$ required True type string pageSize description The maximum number of results to return. If not set, the service selects a default. format int32 location query type integer pageToken description A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. location query type string path v1alpha1/{+name}/locations response $ref ListLocationsResponse scopes https://www.googleapis.com/auth/cloud-platform resources operations methods cancel description Starts 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`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel httpMethod POST id stream.projects.locations.operations.cancel parameterOrder name parameters name description The name of the operation resource to be cancelled. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name}:cancel request $ref CancelOperationRequest response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes 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`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod DELETE id stream.projects.locations.operations.delete parameterOrder name parameters name description The name of the operation resource to be deleted. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id stream.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations httpMethod GET id stream.projects.locations.operations.list parameterOrder name parameters filter description The standard list filter. location query type string name description The name of the operation's parent resource. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string pageSize description The standard list page size. format int32 location query type integer pageToken description The standard list page token. location query type string path v1alpha1/{+name}/operations response $ref ListOperationsResponse scopes https://www.googleapis.com/auth/cloud-platform revision 20241106 rootUrl https://stream.googleapis.com/ schemas CancelOperationRequest description The request message for Operations.CancelOperation. id CancelOperationRequest properties type object Empty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id Empty properties type object ListLocationsResponse description The response message for Locations.ListLocations. id ListLocationsResponse properties locations description A list of locations that matches the specified filter in the request. items $ref Location type array nextPageToken description The standard List next-page token. type string type object ListOperationsResponse description The response message for Operations.ListOperations. id ListOperationsResponse properties nextPageToken description The standard List next-page token. type string operations description A list of operations that matches the specified filter in the request. items $ref Operation type array type object Location description A resource that represents a Google Cloud location. id Location properties displayName description The friendly name for this location, typically a nearby city name. For example, "Tokyo". type string labels additionalProperties type string description Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} type object locationId description The canonical id for this location. For example: `"us-east1"`. type string metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-specific metadata. For example the available capacity at the given location. type object name description Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` type string type object Operation description This resource represents a long-running operation that is the result of a network API call. id Operation properties done description If 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. type boolean error $ref Status description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object OperationMetadata description Represents the metadata of the long-running operation. id OperationMetadata properties apiVersion description Output only. API version used to start the operation. readOnly True type string createTime description Output only. The time the operation was created. format google-datetime readOnly True type string endTime description Output only. The time the operation finished running. format google-datetime readOnly True type string requestedCancellation description Output 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`. readOnly True type boolean statusMessage description Output only. Human-readable status of the operation, if any. readOnly True type string target description Output only. Server-defined resource path for the target of the operation. readOnly True type string verb description Output only. Name of the verb executed by the operation. readOnly True type string type object Status description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id Status properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object servicePath title Immersive Stream for XR API version v1alpha1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/stream-v1beta	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://stream.googleapis.com/ batchPath batch canonicalName Stream description discoveryVersion v1 documentationLink https://cloud.google.com fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id stream:v1beta kind discovery#restDescription mtlsRootUrl https://stream.mtls.googleapis.com/ name stream ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations methods get description Gets information about a location. flatPath v1beta/projects/{projectsId}/locations/{locationsId} httpMethod GET id stream.projects.locations.get parameterOrder name parameters name description Resource name for the location. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1beta/{+name} response $ref Location scopes https://www.googleapis.com/auth/cloud-platform list description Lists information about the supported locations for this service. flatPath v1beta/projects/{projectsId}/locations httpMethod GET id stream.projects.locations.list parameterOrder name parameters filter description A 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). location query type string name description The resource that owns the locations collection, if applicable. location path pattern ^projects/[^/]+$ required True type string pageSize description The maximum number of results to return. If not set, the service selects a default. format int32 location query type integer pageToken description A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. location query type string path v1beta/{+name}/locations response $ref ListLocationsResponse scopes https://www.googleapis.com/auth/cloud-platform resources operations methods cancel description Starts 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`. flatPath v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel httpMethod POST id stream.projects.locations.operations.cancel parameterOrder name parameters name description The name of the operation resource to be cancelled. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1beta/{+name}:cancel request $ref CancelOperationRequest response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes 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`. flatPath v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod DELETE id stream.projects.locations.operations.delete parameterOrder name parameters name description The name of the operation resource to be deleted. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1beta/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets 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. flatPath v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id stream.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1beta/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. flatPath v1beta/projects/{projectsId}/locations/{locationsId}/operations httpMethod GET id stream.projects.locations.operations.list parameterOrder name parameters filter description The standard list filter. location query type string name description The name of the operation's parent resource. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string pageSize description The standard list page size. format int32 location query type integer pageToken description The standard list page token. location query type string path v1beta/{+name}/operations response $ref ListOperationsResponse scopes https://www.googleapis.com/auth/cloud-platform revision 20241106 rootUrl https://stream.googleapis.com/ schemas CancelOperationRequest description The request message for Operations.CancelOperation. id CancelOperationRequest properties type object Empty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id Empty properties type object ListLocationsResponse description The response message for Locations.ListLocations. id ListLocationsResponse properties locations description A list of locations that matches the specified filter in the request. items $ref Location type array nextPageToken description The standard List next-page token. type string type object ListOperationsResponse description The response message for Operations.ListOperations. id ListOperationsResponse properties nextPageToken description The standard List next-page token. type string operations description A list of operations that matches the specified filter in the request. items $ref Operation type array type object Location description A resource that represents a Google Cloud location. id Location properties displayName description The friendly name for this location, typically a nearby city name. For example, "Tokyo". type string labels additionalProperties type string description Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} type object locationId description The canonical id for this location. For example: `"us-east1"`. type string metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-specific metadata. For example the available capacity at the given location. type object name description Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` type string type object Operation description This resource represents a long-running operation that is the result of a network API call. id Operation properties done description If 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. type boolean error $ref Status description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object OperationMetadata description Represents the metadata of the long-running operation. id OperationMetadata properties apiVersion description Output only. API version used to start the operation. readOnly True type string createTime description Output only. The time the operation was created. format google-datetime readOnly True type string endTime description Output only. The time the operation finished running. format google-datetime readOnly True type string requestedCancellation description Output 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`. readOnly True type boolean statusMessage description Output only. Human-readable status of the operation, if any. readOnly True type string target description Output only. Server-defined resource path for the target of the operation. readOnly True type string verb description Output only. Name of the verb executed by the operation. readOnly True type string type object Status description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id Status properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object servicePath title Immersive Stream for XR API version v1beta version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/sts-	values_changed root['revision'] new_value 20250203 old_value 20250127
prod/sts-v1	values_changed root['revision'] new_value 20250203 old_value 20250127
prod/sts-v1beta	values_changed root['revision'] new_value 20250203 old_value 20250127
prod/tagmanager-	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/tagmanager-v1	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/tagmanager-v2	values_changed root['revision'] new_value 20250205 old_value 20250203
prod/telemetry-	values_changed root['revision'] new_value 20250203 old_value 20250127
prod/testing-	values_changed root['revision'] new_value 20250204 old_value 20250131
prod/testing-v1	values_changed root['revision'] new_value 20250204 old_value 20250131
prod/tiereports-pa-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/tiereports-pa-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/tile-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/tile-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/toolresults-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/toolresults-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/toolresults-v1beta3	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/tpu-	values_changed root['revision'] new_value 20250203 old_value 20250130
prod/tpu-v1alpha1	values_changed root['revision'] new_value 20250203 old_value 20250130
prod/tpu-v2	values_changed root['revision'] new_value 20250203 old_value 20250130
prod/tpu-v2alpha1	values_changed root['revision'] new_value 20250203 old_value 20250130
prod/transcoder-	values_changed root['revision'] new_value 20250129 old_value 20250120
prod/transcoder-v1	values_changed root['revision'] new_value 20250129 old_value 20250120
prod/travelimpactmodel-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/travelimpactmodel-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/travelpartner-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/travelpartner-v3	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/travelpartnerprices-	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/travelpartnerprices-v1	values_changed root['revision'] new_value 20250206 old_value 20250204
prod/us-artifactregistry-v1beta2	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/us-assuredworkloads-	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/us-assuredworkloads-v1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/us-assuredworkloads-v1beta1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/us-central1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-artifactregistry-	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/us-central1-artifactregistry-v1	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/us-central1-artifactregistry-v1beta2	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/us-central1-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-central1-cloudbuild-	values_changed root['resources']['projects']['resources']['locations']['resources']['connections']['methods']['processWebhook']['parameters']['webhookKey']['description'] new_value Arbitrary additional key to find the matching repository for a webhook event if needed. old_value Arbitrary additional key to find the maching repository for a webhook event if needed. root['revision'] new_value 20250129 old_value 20250114
prod/us-central1-cloudbuild-v1	values_changed root['revision'] new_value 20250129 old_value 20250114
prod/us-central1-cloudbuild-v2	values_changed root['resources']['projects']['resources']['locations']['resources']['connections']['methods']['processWebhook']['parameters']['webhookKey']['description'] new_value Arbitrary additional key to find the matching repository for a webhook event if needed. old_value Arbitrary additional key to find the maching repository for a webhook event if needed. root['revision'] new_value 20250129 old_value 20250114
prod/us-central1-connectgateway-	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://connectgateway.googleapis.com/ batchPath batch canonicalName CONNECT GATEWAY description The Connect Gateway service allows connectivity from external parties to connected Kubernetes clusters. discoveryVersion v1 documentationLink https://cloud.google.com/kubernetes-engine/connect/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id connectgateway:v1beta1 kind discovery#restDescription mtlsRootUrl https://connectgateway.mtls.googleapis.com/ name connectgateway ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations resources memberships methods generateCredentials description GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway. flatPath v1beta1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateCredentials httpMethod GET id connectgateway.projects.locations.memberships.generateCredentials parameterOrder name parameters forceUseAgent description Optional. Whether to force the use of Connect Agent-based transport in the generated kubeconfig. This will return a configuration that uses Connect Agent as the underlying transport mechanism for cluster types that would otherwise have used a different transport. Requires that Connect Agent be installed on the cluster. Setting this field to false is equivalent to not setting it. location query type boolean impersonatedServiceAccount description Optional. Service account to impersonate when using the generated kubeconfig. This should only be specified if all calls using this kubeconfig should be made using impersonation of the same service account. location query type string kubernetesNamespace description Optional. The namespace to use in the generated kubeconfig context. If this field is specified, the server will set the `namespace` field in kubeconfig context. If not specified, the `namespace` field is omitted. location query type string name description Required. The Fleet membership resource. location path pattern ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$ required True type string operatingSystem description Optional. The operating system on which the generated kubeconfig will be used. enum OPERATING_SYSTEM_UNSPECIFIED OPERATING_SYSTEM_WINDOWS enumDescriptions Generates a kubeconfig that works for all operating systems not defined below. Generates a kubeconfig that is specifically designed to work with Windows. location query type string version description Optional. The Connect Gateway version to be used in the generated kubeconfig. Leave this field blank to let the server choose the version (recommended). location query type string path v1beta1/{+name}:generateCredentials response $ref GenerateCredentialsResponse scopes https://www.googleapis.com/auth/cloud-platform v1beta1 methods delete description DeleteResource performs an HTTP DELETE on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod DELETE id connectgateway.delete parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform get description GetResource performs an HTTP GET request on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod GET id connectgateway.get parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform patch description PatchResource performs an HTTP PATCH on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod PATCH id connectgateway.patch parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform postResource description PostResource performs an HTTP POST on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod POST id connectgateway.postResource parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform putResource description PutResource performs an HTTP PUT on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod PUT id connectgateway.putResource parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform revision 20250127 rootUrl https://connectgateway.googleapis.com/ schemas GenerateCredentialsResponse description Connection information for a particular membership. id GenerateCredentialsResponse properties endpoint description The generated URI of the cluster as accessed through the Connect Gateway API. type string kubeconfig description A full YAML kubeconfig in serialized format. format byte type string type object HttpBody description Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. id HttpBody properties contentType description The HTTP Content-Type header value specifying the content type of the body. type string data description The HTTP request/response body as raw binary. format byte type string extensions description Application specific response metadata. Must be set in the first response for streaming APIs. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array type object servicePath title Connect Gateway API version v1beta1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/us-central1-connectgateway-v1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://connectgateway.googleapis.com/ batchPath batch canonicalName CONNECT GATEWAY description The Connect Gateway service allows connectivity from external parties to connected Kubernetes clusters. discoveryVersion v1 documentationLink https://cloud.google.com/kubernetes-engine/connect/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id connectgateway:v1 kind discovery#restDescription mtlsRootUrl https://connectgateway.mtls.googleapis.com/ name connectgateway ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations resources memberships methods generateCredentials description GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway. flatPath v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateCredentials httpMethod GET id connectgateway.projects.locations.memberships.generateCredentials parameterOrder name parameters forceUseAgent description Optional. Whether to force the use of Connect Agent-based transport in the generated kubeconfig. This will return a configuration that uses Connect Agent as the underlying transport mechanism for cluster types that would otherwise have used a different transport. Requires that Connect Agent be installed on the cluster. Setting this field to false is equivalent to not setting it. location query type boolean impersonatedServiceAccount description Optional. Service account to impersonate when using the generated kubeconfig. This should only be specified if all calls using this kubeconfig should be made using impersonation of the same service account. location query type string kubernetesNamespace description Optional. The namespace to use in the generated kubeconfig context. If this field is specified, the server will set the `namespace` field in kubeconfig context. If not specified, the `namespace` field is omitted. location query type string name description Required. The Fleet membership resource. location path pattern ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$ required True type string operatingSystem description Optional. The operating system on which the generated kubeconfig will be used. enum OPERATING_SYSTEM_UNSPECIFIED OPERATING_SYSTEM_WINDOWS enumDescriptions Generates a kubeconfig that works for all operating systems not defined below. Generates a kubeconfig that is specifically designed to work with Windows. location query type string version description Optional. The Connect Gateway version to be used in the generated kubeconfig. Leave this field blank to let the server choose the version (recommended). location query type string path v1/{+name}:generateCredentials response $ref GenerateCredentialsResponse scopes https://www.googleapis.com/auth/cloud-platform v1 methods delete description DeleteResource performs an HTTP DELETE on the Kubernetes API Server. flatPath v1/{v1Id} httpMethod DELETE id connectgateway.delete parameterOrder v1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1Id location path required True type string path v1/{+v1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform get description GetResource performs an HTTP GET request on the Kubernetes API Server. flatPath v1/{v1Id} httpMethod GET id connectgateway.get parameterOrder v1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1Id location path required True type string path v1/{+v1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform patch description PatchResource performs an HTTP PATCH on the Kubernetes API Server. flatPath v1/{v1Id} httpMethod PATCH id connectgateway.patch parameterOrder v1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1Id location path required True type string path v1/{+v1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform postResource description PostResource performs an HTTP POST on the Kubernetes API Server. flatPath v1/{v1Id} httpMethod POST id connectgateway.postResource parameterOrder v1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1Id location path required True type string path v1/{+v1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform putResource description PutResource performs an HTTP PUT on the Kubernetes API Server. flatPath v1/{v1Id} httpMethod PUT id connectgateway.putResource parameterOrder v1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1Id location path required True type string path v1/{+v1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform revision 20250127 rootUrl https://connectgateway.googleapis.com/ schemas GenerateCredentialsResponse description Connection information for a particular membership. id GenerateCredentialsResponse properties endpoint description The generated URI of the cluster as accessed through the Connect Gateway API. type string kubeconfig description A full YAML kubeconfig in serialized format. format byte type string type object HttpBody description Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. id HttpBody properties contentType description The HTTP Content-Type header value specifying the content type of the body. type string data description The HTTP request/response body as raw binary. format byte type string extensions description Application specific response metadata. Must be set in the first response for streaming APIs. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array type object servicePath title Connect Gateway API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/us-central1-connectgateway-v1beta1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://connectgateway.googleapis.com/ batchPath batch canonicalName CONNECT GATEWAY description The Connect Gateway service allows connectivity from external parties to connected Kubernetes clusters. discoveryVersion v1 documentationLink https://cloud.google.com/kubernetes-engine/connect/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id connectgateway:v1beta1 kind discovery#restDescription mtlsRootUrl https://connectgateway.mtls.googleapis.com/ name connectgateway ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations resources memberships methods generateCredentials description GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway. flatPath v1beta1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateCredentials httpMethod GET id connectgateway.projects.locations.memberships.generateCredentials parameterOrder name parameters forceUseAgent description Optional. Whether to force the use of Connect Agent-based transport in the generated kubeconfig. This will return a configuration that uses Connect Agent as the underlying transport mechanism for cluster types that would otherwise have used a different transport. Requires that Connect Agent be installed on the cluster. Setting this field to false is equivalent to not setting it. location query type boolean impersonatedServiceAccount description Optional. Service account to impersonate when using the generated kubeconfig. This should only be specified if all calls using this kubeconfig should be made using impersonation of the same service account. location query type string kubernetesNamespace description Optional. The namespace to use in the generated kubeconfig context. If this field is specified, the server will set the `namespace` field in kubeconfig context. If not specified, the `namespace` field is omitted. location query type string name description Required. The Fleet membership resource. location path pattern ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$ required True type string operatingSystem description Optional. The operating system on which the generated kubeconfig will be used. enum OPERATING_SYSTEM_UNSPECIFIED OPERATING_SYSTEM_WINDOWS enumDescriptions Generates a kubeconfig that works for all operating systems not defined below. Generates a kubeconfig that is specifically designed to work with Windows. location query type string version description Optional. The Connect Gateway version to be used in the generated kubeconfig. Leave this field blank to let the server choose the version (recommended). location query type string path v1beta1/{+name}:generateCredentials response $ref GenerateCredentialsResponse scopes https://www.googleapis.com/auth/cloud-platform v1beta1 methods delete description DeleteResource performs an HTTP DELETE on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod DELETE id connectgateway.delete parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform get description GetResource performs an HTTP GET request on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod GET id connectgateway.get parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform patch description PatchResource performs an HTTP PATCH on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod PATCH id connectgateway.patch parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform postResource description PostResource performs an HTTP POST on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod POST id connectgateway.postResource parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform putResource description PutResource performs an HTTP PUT on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod PUT id connectgateway.putResource parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform revision 20250127 rootUrl https://connectgateway.googleapis.com/ schemas GenerateCredentialsResponse description Connection information for a particular membership. id GenerateCredentialsResponse properties endpoint description The generated URI of the cluster as accessed through the Connect Gateway API. type string kubeconfig description A full YAML kubeconfig in serialized format. format byte type string type object HttpBody description Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. id HttpBody properties contentType description The HTTP Content-Type header value specifying the content type of the body. type string data description The HTTP request/response body as raw binary. format byte type string extensions description Application specific response metadata. Must be set in the first response for streaming APIs. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array type object servicePath title Connect Gateway API version v1beta1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/us-central1-contactcenterinsights-v1	values_changed root['revision'] new_value 20250203 old_value 20250127
prod/us-central1-pubsub-	values_changed root['revision'] new_value 20250128 old_value 20250123
prod/us-central1-pubsub-v1	dictionary_item_added root['schemas']['JavaScriptUDF'] root['schemas']['MessageTransform'] root['schemas']['Subscription']['properties']['messageTransforms'] root['schemas']['Topic']['properties']['messageTransforms'] values_changed root['revision'] new_value 20250128 old_value 20250123
prod/us-central1-pubsub-v1beta2	values_changed root['revision'] new_value 20250128 old_value 20250123
prod/us-chronicle-	values_changed root['revision'] new_value 20250130 old_value 20250124
prod/us-chronicle-v1alpha	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['watchlists']['resources']['entities']['methods']['add'] root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['watchlists']['resources']['entities']['methods']['remove'] root['schemas']['LegacyStreamDetectionAlertsRequest']['properties']['pageStartTime'] root['schemas']['LegacyStreamDetectionAlertsRequest']['properties']['pageToken'] root['schemas']['LegacyStreamDetectionAlertsResponse']['properties']['nextPageStartTime'] root['schemas']['LegacyStreamDetectionAlertsResponse']['properties']['nextPageToken'] values_changed root['resources']['projects']['resources']['locations']['resources']['instances']['resources']['entityRiskScores']['methods']['query']['parameters']['filter']['description'] new_value Filter expression to be applied to the list of Entity Risk Scores. Timestamps use RFC 3339. Read more [here](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) - **risk_window**: Filter field which represents the time window over which an Entity Risk Score is computed. This could be 24 hours or 7 days. Example: `filter=risk_window.start_time >= "2023-08-10T14:20:59.950218416Z" AND risk_window.end_time <= "2023-08-17T14:20:59.950219626Z"` - **risk_score**: Filter by risk_score in the current risk window and time window. Example: `filter=risk_score<20` - **risk_delta**: Filter by risk_delta in the risk window and time window. Example: `filter=risk_delta>=12 AND risk_delta<=850` Risk_delta is a percentage representation of change. There are multiple cases of risk_delta calculation: 1. Previous risk_score was 0 (either truly 0 or non-existent) and current risk score is a non 0 number. This is a 100 percent positive delta. 2. Previous risk score and current risk score are equal (eg. both 0): delta is 0 since there was no change. 3. Previous risk score is higher than current score: delta is negative. 4. Previous risk score is lower than current score: delta is positive. 5. If risk_delta calculation yields a value > 200%, the delta is instead set to a constant value of 200%. - **raw_risk_score**: Filter by raw_risk_score in the current risk window and time window. Example: `filter=raw_risk_score<100` - **raw_risk_delta**: Filter by raw_risk_delta in the risk window and time window. Example: `filter=raw_risk_delta>=5 AND raw_risk_delta<=100` - **detections_count**: Filter by number of detections for the entity in the risk window and time window. Example: `filter=detections_count < 10` - **entity**: Filter by details of the entity. Example: `filter=entity.metadata.entity_type="ASSET"` - **entity_indicator**: Filter by entity indicator. The sub fields need to be explicitly requested. Examples: - `filter=entity_indicator.email: "test@example.com"` - `filter=entity_indicator.hostname="test_hostname"` Supported entity_indicator subfields: - entity_indicator.windows_sid - entity_indicator.email - entity_indicator.user_name - entity_indicator.employee_id - entity_indicator.hostname - entity_indicator.mac - entity_indicator.product_id - entity_indicator.asset_ip_address - entity_indicator.product_object_id - entity_indicator.Namespace This can be used in conjunction with an entity_indicator for an asset (hostname, mac, product_id, asset_ip_address). - **risk_score_version**: Filter results by risk score version. Example: `filter=risk_score_version = "RISK_SCORE_VERSION_V0_01"` - **lookback_interval**: Filter by the lookback interval. Example: `filter=lookback_interval.start_time >= "2023-08-10T14:20:59.950218416Z" AND lookback_interval.end_time <= "2023-08-17T14:20:59.950219626Z"` old_value Filter expression to be applied to the list of Entity Risk Scores. Timestamps use RFC 3339. Read more [here](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp) - **risk_window**: Filter field which represents the time window over which an Entity Risk Score is computed. This could be 24 hours or 7 days. Example: `filter=risk_window.start_time >= "2023-08-10T14:20:59.950218416Z" AND risk_window.end_time <= "2023-08-17T14:20:59.950219626Z"` - **risk_score**: Filter by risk_score in the current risk window and time window. Example: `filter=risk_score<20` - **risk_delta**: Filter by risk_delta in the risk window and time window. Example: `filter=risk_delta>=12 AND risk_delta<=850` Risk_delta is a percentage representation of change. There are multiple cases of risk_delta calculation: 1. Previous risk_score was 0 (either truly 0 or non-existent) and current risk score is a non 0 number. This is a 100 percent positive delta. 2. Previous risk score and current risk score are equal (eg. both 0): delta is 0 since there was no change. 3. Previous risk score is higher than current score: delta is negative. 4. Previous risk score is lower than current score: delta is positive. 5. If risk_delta calculation yields a value > 200%, the delta is instead set to a constant value of 200%. - **raw_risk_score**: Filter by raw_risk_score in the current risk window and time window. Example: `filter=raw_risk_score<100` - **raw_risk_delta**: Filter by raw_risk_delta in the risk window and time window. Example: `filter=raw_risk_delta>=5 AND raw_risk_delta<=100` - **detections_count**: Filter by number of detections for the entity in the risk window and time window. Example: `filter=detections_count < 10` - **entity**: Filter by details of the entity. Example: `filter=entity.metadata.entity_type="ASSET"` - **entity_indicator**: Filter by entity indicator. The sub fields need to be explicitly requested. Examples: - `filter=entity_indicator.email: "test@example.com"` - `filter=entity_indicator.hostname="test_hostname"` Supported entity_indicator subfields: - entity_indicator.windows_sid - entity_indicator.email - entity_indicator.user_name - entity_indicator.employee_id - entity_indicator.hostname - entity_indicator.mac - entity_indicator.product_id - entity_indicator.asset_ip_address - entity_indicator.Namespace This can be used in conjunction with an entity_indicator for an asset (hostname, mac, product_id, asset_ip_address). - **risk_score_version**: Filter results by risk score version. Example: `filter=risk_score_version = "RISK_SCORE_VERSION_V0_01"` - **lookback_interval**: Filter by the lookback interval. Example: `filter=lookback_interval.start_time >= "2023-08-10T14:20:59.950218416Z" AND lookback_interval.end_time <= "2023-08-17T14:20:59.950219626Z"` root['revision'] new_value 20250130 old_value 20250124 root['schemas']['Collection']['description'] new_value Collection represents a container of objects (such as events, entity context metadata, detection finding metadata) and state (such as investigation details). BEGIN GOOGLE-INTERNAL See go/udm:collections for additional details. END GOOGLE-INTERNAL An example use case for Collection is to model a detection and investigation from detection finding metadata to investigative state collected in the course of the investigation. For more complex investigation and response workflows a Collection could represent an incident consisting of multiple child findings or incidents. This can be expanded on to model remediation elements of a full detection and response workflow. NEXT TAG: 20 old_value Collection represents a container of objects (such as events, entity context metadata, detection finding metadata) and state (such as investigation details). BEGIN GOOGLE-INTERNAL See go/udm:collections for additional details. END GOOGLE-INTERNAL An example use case for Collection is to model a detection and investigation from detection finding metadata to investigative state collected in the course of the investigation. For more complex investigation and response workflows a Collection could represent an incident consisting of multiple child findings or incidents. This can be expanded on to model remediation elements of a full detection and response workflow. NEXT TAG: 20 LINT.IfChange root['schemas']['LegacyStreamDetectionAlertsRequest']['properties']['continuationTime']['description'] new_value Optional. DEPRECATED: Prefer using `page_token` or `page_start_time` instead. A continuation timestamp, from a previous `LegacyStreamDetectionAlerts` connection. When reconnecting, clients should provide the maximum continuation_time they have received. All detection alerts discovered after `continuation_time` will be streamed to the client. If the value is older than 1 week, the connection request will be rejected; other RPCs should be used to get older detections. old_value Optional. A continuation timestamp, from a previous `LegacyStreamDetectionAlerts` connection. When reconnecting, clients should provide the maximum continuation_time they have received. When initiating the very first connection, clients should leave this unspecified. If unspecified, this defaults to the time of the connection. All detection alerts discovered after continuation_time will be streamed to the client. If the value is older than 1 week, the connection request will be rejected; other RPCs should be used to get older detections. root['schemas']['LegacyStreamDetectionAlertsResponse']['properties']['continuationTime']['description'] new_value DEPRECATED: Prefer using `page_token` instead by specifying either `page_start_time` or `page_token` in the request. A continuation timestamp that can be sent as `continuation_time` when reconnecting to this streaming RPC. old_value A continuation timestamp that can be sent as `continuation_time` when reconnecting to this streaming RPC. iterable_item_added root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][465] VICARIUS_VRX_EVENTS root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][1387] CLICKHOUSE root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2031] EXTERRO_FTK_CENTRAL root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2032] CROWDSTRIKE_RECON root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2033] CLOUDFLARE_PAGESHIELD root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2034] FORTRA_VM root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2035] GCP_CLOUD_ASSET_INVENTORY root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2036] RAPID_IDENTITY root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2037] SLSFR_VERTEX_IOC root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2038] ARCDA_VISTA root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2039] PRMTH_WSO2 root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2040] MC001_CLICKS_ENTERPAT root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2041] MC001_CLICKS_CLIUSERS root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2042] MC001_ROSHTOV_CLICKS root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2043] MC001_INFOSEC_BLOCK_TOOL root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2044] MC001_MACCABI_PHARMACY root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2045] SPACELIFT root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2046] PAVE root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2671] PRMTH_FIRSTIQ root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2672] PRMTH_PWSS root['schemas']['IoCDiscoveryInfo']['properties']['logType']['enum'][2694] RQ5XB66T_PINGCAP_TIDB_DB_AUDIT root['schemas']['RawLog']['properties']['type']['enum'][465] VICARIUS_VRX_EVENTS root['schemas']['RawLog']['properties']['type']['enum'][1387] CLICKHOUSE root['schemas']['RawLog']['properties']['type']['enum'][2031] EXTERRO_FTK_CENTRAL root['schemas']['RawLog']['properties']['type']['enum'][2032] CROWDSTRIKE_RECON root['schemas']['RawLog']['properties']['type']['enum'][2033] CLOUDFLARE_PAGESHIELD root['schemas']['RawLog']['properties']['type']['enum'][2034] FORTRA_VM root['schemas']['RawLog']['properties']['type']['enum'][2035] GCP_CLOUD_ASSET_INVENTORY root['schemas']['RawLog']['properties']['type']['enum'][2036] RAPID_IDENTITY root['schemas']['RawLog']['properties']['type']['enum'][2037] SLSFR_VERTEX_IOC root['schemas']['RawLog']['properties']['type']['enum'][2038] ARCDA_VISTA root['schemas']['RawLog']['properties']['type']['enum'][2039] PRMTH_WSO2 root['schemas']['RawLog']['properties']['type']['enum'][2040] MC001_CLICKS_ENTERPAT root['schemas']['RawLog']['properties']['type']['enum'][2041] MC001_CLICKS_CLIUSERS root['schemas']['RawLog']['properties']['type']['enum'][2042] MC001_ROSHTOV_CLICKS root['schemas']['RawLog']['properties']['type']['enum'][2043] MC001_INFOSEC_BLOCK_TOOL root['schemas']['RawLog']['properties']['type']['enum'][2044] MC001_MACCABI_PHARMACY root['schemas']['RawLog']['properties']['type']['enum'][2045] SPACELIFT root['schemas']['RawLog']['properties']['type']['enum'][2046] PAVE root['schemas']['RawLog']['properties']['type']['enum'][2671] PRMTH_FIRSTIQ root['schemas']['RawLog']['properties']['type']['enum'][2672] PRMTH_PWSS root['schemas']['RawLog']['properties']['type']['enum'][2694] RQ5XB66T_PINGCAP_TIDB_DB_AUDIT root['schemas']['SIEventData']['properties']['rawLogType']['enum'][465] VICARIUS_VRX_EVENTS root['schemas']['SIEventData']['properties']['rawLogType']['enum'][1387] CLICKHOUSE root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2031] EXTERRO_FTK_CENTRAL root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2032] CROWDSTRIKE_RECON root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2033] CLOUDFLARE_PAGESHIELD root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2034] FORTRA_VM root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2035] GCP_CLOUD_ASSET_INVENTORY root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2036] RAPID_IDENTITY root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2037] SLSFR_VERTEX_IOC root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2038] ARCDA_VISTA root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2039] PRMTH_WSO2 root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2040] MC001_CLICKS_ENTERPAT root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2041] MC001_CLICKS_CLIUSERS root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2042] MC001_ROSHTOV_CLICKS root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2043] MC001_INFOSEC_BLOCK_TOOL root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2044] MC001_MACCABI_PHARMACY root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2045] SPACELIFT root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2046] PAVE root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2671] PRMTH_FIRSTIQ root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2672] PRMTH_PWSS root['schemas']['SIEventData']['properties']['rawLogType']['enum'][2694] RQ5XB66T_PINGCAP_TIDB_DB_AUDIT
prod/us-chronicle-v1beta	values_changed root['revision'] new_value 20250130 old_value 20250124
prod/us-cloudkms-	values_changed root['revision'] new_value 20250203 old_value 20250124
prod/us-cloudkms-v1	values_changed root['revision'] new_value 20250203 old_value 20250124
prod/us-discoveryengine-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/us-discoveryengine-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/us-discoveryengine-v1alpha	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/us-discoveryengine-v1beta	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/us-east1-aiplatform-	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/us-east1-aiplatform-v1	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/us-east1-aiplatform-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/us-east1-aiplatform-v1beta1	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/us-east1-cloudkms-	values_changed root['revision'] new_value 20250203 old_value 20250124
prod/us-east1-cloudkms-v1	values_changed root['revision'] new_value 20250203 old_value 20250124
prod/us-east1-connectgateway-v1beta1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://connectgateway.googleapis.com/ batchPath batch canonicalName CONNECT GATEWAY description The Connect Gateway service allows connectivity from external parties to connected Kubernetes clusters. discoveryVersion v1 documentationLink https://cloud.google.com/kubernetes-engine/connect/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id connectgateway:v1beta1 kind discovery#restDescription mtlsRootUrl https://connectgateway.mtls.googleapis.com/ name connectgateway ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations resources memberships methods generateCredentials description GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway. flatPath v1beta1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateCredentials httpMethod GET id connectgateway.projects.locations.memberships.generateCredentials parameterOrder name parameters forceUseAgent description Optional. Whether to force the use of Connect Agent-based transport in the generated kubeconfig. This will return a configuration that uses Connect Agent as the underlying transport mechanism for cluster types that would otherwise have used a different transport. Requires that Connect Agent be installed on the cluster. Setting this field to false is equivalent to not setting it. location query type boolean impersonatedServiceAccount description Optional. Service account to impersonate when using the generated kubeconfig. This should only be specified if all calls using this kubeconfig should be made using impersonation of the same service account. location query type string kubernetesNamespace description Optional. The namespace to use in the generated kubeconfig context. If this field is specified, the server will set the `namespace` field in kubeconfig context. If not specified, the `namespace` field is omitted. location query type string name description Required. The Fleet membership resource. location path pattern ^projects/[^/]+/locations/[^/]+/memberships/[^/]+$ required True type string operatingSystem description Optional. The operating system on which the generated kubeconfig will be used. enum OPERATING_SYSTEM_UNSPECIFIED OPERATING_SYSTEM_WINDOWS enumDescriptions Generates a kubeconfig that works for all operating systems not defined below. Generates a kubeconfig that is specifically designed to work with Windows. location query type string version description Optional. The Connect Gateway version to be used in the generated kubeconfig. Leave this field blank to let the server choose the version (recommended). location query type string path v1beta1/{+name}:generateCredentials response $ref GenerateCredentialsResponse scopes https://www.googleapis.com/auth/cloud-platform v1beta1 methods delete description DeleteResource performs an HTTP DELETE on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod DELETE id connectgateway.delete parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform get description GetResource performs an HTTP GET request on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod GET id connectgateway.get parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform patch description PatchResource performs an HTTP PATCH on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod PATCH id connectgateway.patch parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform postResource description PostResource performs an HTTP POST on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod POST id connectgateway.postResource parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform putResource description PutResource performs an HTTP PUT on the Kubernetes API Server. flatPath v1beta1/{v1beta1Id} httpMethod PUT id connectgateway.putResource parameterOrder v1beta1Id parameters contentType description The HTTP Content-Type header value specifying the content type of the body. location query type string data description The HTTP request/response body as raw binary. format byte location query type string extensions additionalProperties description Properties of the object. Contains field @type with type URL. type any description Application specific response metadata. Must be set in the first response for streaming APIs. location query repeated True type object v1beta1Id location path required True type string path v1beta1/{+v1beta1Id} response $ref HttpBody scopes https://www.googleapis.com/auth/cloud-platform revision 20250201 rootUrl https://connectgateway.googleapis.com/ schemas GenerateCredentialsResponse description Connection information for a particular membership. id GenerateCredentialsResponse properties endpoint description The generated URI of the cluster as accessed through the Connect Gateway API. type string kubeconfig description A full YAML kubeconfig in serialized format. format byte type string type object HttpBody description Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. id HttpBody properties contentType description The HTTP Content-Type header value specifying the content type of the body. type string data description The HTTP request/response body as raw binary. format byte type string extensions description Application specific response metadata. Must be set in the first response for streaming APIs. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array type object servicePath title Connect Gateway API version v1beta1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/us-east1-containerfilesystem-v1	values_changed root['revision'] new_value 20250131 old_value 20250125
prod/us-east1-content-remotebuildexecution-	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-east1-content-remotebuildexecution-v1	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-east1-content-remotebuildexecution-v1alpha	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-east1-content-remotebuildexecution-v1test2	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-east1-content-remotebuildexecution-v2	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-east1-d-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east1-d-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east1-d-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east1-d-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east1-d-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east1-d-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east1-d-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east1-datacatalog-	values_changed root['revision'] new_value 20250131 old_value 20250122
prod/us-east1-dialogflow-	values_changed root['revision'] new_value 20250207 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-east1-dialogflow-v1	values_changed root['revision'] new_value 20250207 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-east1-dialogflow-v2	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250207 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-east1-dialogflow-v2beta1	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250207 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-east1-dialogflow-v3	values_changed root['revision'] new_value 20250207 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-east1-dialogflow-v3alpha1	values_changed root['revision'] new_value 20250207 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-east1-dialogflow-v3beta1	values_changed root['revision'] new_value 20250207 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-east1-remotebuildexecution-	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-east1-remotebuildexecution-v1	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-east1-remotebuildexecution-v1alpha	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-east1-remotebuildexecution-v1test2	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-east1-remotebuildexecution-v2	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-east1-run-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/us-east1-run-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/us-east1-run-v2	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/us-east2-iamcredentials-	values_changed root['revision'] new_value 20250130 old_value 20250122
prod/us-east2-iamcredentials-v1	values_changed root['revision'] new_value 20250130 old_value 20250122
prod/us-east4-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-artifactregistry-v1beta1	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/us-east4-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-gkemulticloud-	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/us-east4-gkemulticloud-v1	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/us-east4-iamcredentials-	values_changed root['revision'] new_value 20250130 old_value 20250122
prod/us-east4-iamcredentials-v1	values_changed root['revision'] new_value 20250130 old_value 20250122
prod/us-east4-logging-	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/us-east4-logging-v1beta3	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/us-east4-logging-v2beta1	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/us-east4-monitoring-	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/us-east4-monitoring-v1	dictionary_item_removed root['schemas']['PieChartDataSet']['properties']['breakdowns'] values_changed root['revision'] new_value 20250127 old_value 20250120
prod/us-east4-monitoring-v3	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/us-east4-pubsub-	values_changed root['revision'] new_value 20250128 old_value 20250123
prod/us-east4-pubsub-v1	dictionary_item_added root['schemas']['JavaScriptUDF'] root['schemas']['MessageTransform'] root['schemas']['Subscription']['properties']['messageTransforms'] root['schemas']['Topic']['properties']['messageTransforms'] values_changed root['revision'] new_value 20250128 old_value 20250123
prod/us-east4-pubsub-v1beta2	values_changed root['revision'] new_value 20250128 old_value 20250123
prod/us-east4-speech-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-speech-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-speech-v1p1beta1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-speech-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east4-workflowexecutions-	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-east4-workflowexecutions-v1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-east4-workflowexecutions-v1alpha1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-east4-workflowexecutions-v1beta	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-east5-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-east5-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-south1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-south1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-south1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-south1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-south1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-south1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-south1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west1-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west1-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west1-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west1-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west1-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west1-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west1-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west1-aiplatform-	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['featureGroups']['resources']['featureMonitors']['methods']['patch'] root['schemas']['GoogleCloudAiplatformV1beta1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1RolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1DeployedModel']['properties']['rolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1beta1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1beta1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1beta1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/us-west1-aiplatform-v1	dictionary_item_added root['schemas']['GoogleCloudAiplatformV1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/us-west1-aiplatform-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/us-west1-aiplatform-v1beta1	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['featureGroups']['resources']['featureMonitors']['methods']['patch'] root['schemas']['GoogleCloudAiplatformV1beta1AutoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1RolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1DeployedModel']['properties']['rolloutOptions'] root['schemas']['GoogleCloudAiplatformV1beta1EvaluateInstancesRequest']['properties']['autoraterConfig'] root['schemas']['GoogleCloudAiplatformV1beta1MachineSpec']['properties']['multihostGpuNodeCount'] root['schemas']['GoogleCloudAiplatformV1beta1PointwiseMetricSpec']['properties']['systemInstruction'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['failureThreshold'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['initialDelaySeconds'] root['schemas']['GoogleCloudAiplatformV1beta1Probe']['properties']['successThreshold'] values_changed root['resources']['projects']['resources']['locations']['resources']['featureGroups']['methods']['patch']['parameters']['updateMask']['description'] new_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` old_value Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` root['revision'] new_value 20250205 old_value 20250131 root['schemas']['GoogleCloudAiplatformV1beta1ModelExportFormat']['properties']['id']['description'] new_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. * `genie` A tuned Model Garden model. old_value Output only. The ID of the export format. The possible format IDs are: * `tflite` Used for Android mobile devices. * `edgetpu-tflite` Used for [Edge TPU](https://cloud.google.com/edge-tpu/) devices. * `tf-saved-model` A tensorflow model in SavedModel format. * `tf-js` A [TensorFlow.js](https://www.tensorflow.org/js) model that can be used in the browser and in Node.js using JavaScript. * `core-ml` Used for iOS mobile devices. * `custom-trained` A Model that was uploaded or trained by custom code. root['schemas']['GoogleCloudAiplatformV1beta1PairwiseMetricSpec']['properties'] new_value baselineResponseFieldName description Optional. The field name of the baseline response. type string candidateResponseFieldName description Optional. The field name of the candidate response. type string metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string systemInstruction description Optional. System instructions for pairwise metric. type string old_value metricPromptTemplate description Required. Metric prompt template for pairwise metric. type string
prod/us-west1-artifactregistry-v1beta1	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/us-west1-assuredworkloads-	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/us-west1-assuredworkloads-v1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/us-west1-assuredworkloads-v1beta1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/us-west1-cloudkms-	values_changed root['revision'] new_value 20250203 old_value 20250124
prod/us-west1-cloudkms-v1	values_changed root['revision'] new_value 20250203 old_value 20250124
prod/us-west1-content-remotebuildexecution-	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-west1-content-remotebuildexecution-v1	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-west1-content-remotebuildexecution-v1alpha	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-west1-content-remotebuildexecution-v1test2	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-west1-content-remotebuildexecution-v2	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-west1-datalineage-	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/us-west1-datalineage-v1	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/us-west1-dialogflow-	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-west1-dialogflow-v1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-west1-dialogflow-v2	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. Marked deprecated as it hasn't been, and isn't currently, supported. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-west1-dialogflow-v2beta1	dictionary_item_added root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['deprecated'] values_changed root['resources']['projects']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['resources']['projects']['resources']['locations']['resources']['answerRecords']['methods']['list']['parameters']['filter']['description'] new_value Optional. Filters to restrict results to specific answer records. For more information about filtering, see [API Filtering](https://aip.dev/160). old_value Optional. Filters to restrict results to specific answer records. The expression has the following syntax: [AND ] ... The following fields and operators are supported: * conversation_id with equals(=) operator Examples: * "conversation_id=bar" matches answer records in the projects/foo/locations/global/conversations/bar conversation (assuming the parent is projects/foo/locations/global). For more information about filtering, see [API Filtering](https://aip.dev/160). root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-west1-dialogflow-v3	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-west1-dialogflow-v3alpha1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-west1-dialogflow-v3beta1	values_changed root['revision'] new_value 20250128 old_value 20250130 root['schemas']['GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform. root['schemas']['GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceOAuthConfig']['properties']['clientSecret']['description'] new_value Required. The client secret provided by the 3rd party platform. old_value Optional. The client secret provided by the 3rd party platform.
prod/us-west1-gkemulticloud-	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/us-west1-gkemulticloud-v1	values_changed root['revision'] new_value 20250206 old_value 20250110
prod/us-west1-iamcredentials-	values_changed root['revision'] new_value 20250130 old_value 20250122
prod/us-west1-iamcredentials-v1	values_changed root['revision'] new_value 20250130 old_value 20250122
prod/us-west1-monitoring-	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/us-west1-monitoring-v1	dictionary_item_removed root['schemas']['PieChartDataSet']['properties']['breakdowns'] values_changed root['revision'] new_value 20250127 old_value 20250120
prod/us-west1-monitoring-v3	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/us-west1-remotebuildexecution-	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-west1-remotebuildexecution-v1	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-west1-remotebuildexecution-v1alpha	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-west1-remotebuildexecution-v1test2	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-west1-remotebuildexecution-v2	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/us-west1-run-	values_changed root['revision'] new_value 20250205 old_value 20250127 root['schemas']['GoogleCloudRunV2Container']['properties']['baseImageUri']['description'] new_value Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. old_value Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.
prod/us-west1-run-v1	values_changed root['revision'] new_value 20250205 old_value 20250127
prod/us-west1-run-v2	values_changed root['revision'] new_value 20250205 old_value 20250127 root['schemas']['GoogleCloudRunV2Container']['properties']['baseImageUri']['description'] new_value Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update. old_value Base image for this container. Only supported for services. If set. it indicates that the service is enrolled into automatic base image update.
prod/us-west1-workflowexecutions-	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-west1-workflowexecutions-v1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-west1-workflowexecutions-v1alpha1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-west1-workflowexecutions-v1beta	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-west2-aiplatform-	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/us-west2-aiplatform-v1	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/us-west2-aiplatform-v1alpha1	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/us-west2-aiplatform-v1beta1	values_changed root['revision'] new_value 20250205 old_value 20250131
prod/us-west2-artifactregistry-v1beta1	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/us-west2-artifactregistry-v1beta2	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/us-west2-cloudkms-	values_changed root['revision'] new_value 20250124 old_value 20250203
prod/us-west2-containerfilesystem-	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. https://www.googleapis.com/auth/cloud-platform.read-only description View your data across Google Cloud services and see the email address of your Google Account https://www.googleapis.com/auth/devstorage.full_control description Manage your data and permissions in Cloud Storage and see the email address for your Google Account https://www.googleapis.com/auth/devstorage.read_only description View your data in Google Cloud Storage https://www.googleapis.com/auth/devstorage.read_write description Manage your data in Cloud Storage and see the email address of your Google Account basePath baseUrl https://containerfilesystem.googleapis.com/ batchPath batch canonicalName Container File System description Stream images stored in Artifact Registry to GKE discoveryVersion v1 documentationLink https://cloud.google.com/kubernetes-engine/docs/how-to/image-streaming fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id containerfilesystem:v1 kind discovery#restDescription mtlsRootUrl https://containerfilesystem.mtls.googleapis.com/ name containerfilesystem ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects methods auth description Authenticate the request for a given image name. Returns image id and access token. flatPath v1/projects/{projectsId}:auth httpMethod POST id containerfilesystem.projects.auth parameterOrder imageProject parameters imageProject description ID of the project hosting the image in the form of 'projects/my-project'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide (Cloud Riptide). location path pattern ^projects/[^/]+$ required True type string path v1/{+imageProject}:auth request $ref AuthImageRequest response $ref AuthImageReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write resources files methods readContent description Get file contents spanning a requested offset and length within a file. flatPath v1/projects/{projectsId}/files/{filesId} httpMethod GET id containerfilesystem.projects.files.readContent parameterOrder imageProject contentHash parameters accessToken description Access token used to verify access. Not used in GAE Riptide. location query type string contentHash description The SHA256 hexdigest of the file contents (uniquely identifies the file). location path pattern ^[^/]+$ required True type string decryptedContentHash description The SHA256 hexdigest of the decrypted file contents. If set, this means the content_hash field is the encrypted content hash. If the decrypted content is in fileserver caches, it will be returned instead of the encrypted content specified by the content_hash field. The client can determine which version was returned by inspecting the content_hash field of the reply. location query type string filePath description File path is optional unless auth is enabled. File path is used to optimize lookups if a given file is in the authorized layer from access token. location query type string fileSize description File size is optional, and is a hint to the file server, which can use the hint to speculate whether the file is a single-block file. format int64 location query type string imageId description Optional image ID where the file resides. Used only for prefetch list recording on fileserver-proxy for OnePlatform (GKE FUSE) clients. location query type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string length description The length to read. format int64 location query type string offset description The offset into the file from which to read. format int64 location query type string readSessionId description The id of the session (read-ahead/prefetch) that the current request belongs to. It takes the following forms: - "original_req_offset:original_req_length:read_ahead_size" for read ahead. location query type string retryAttempt description Retry attempt number. format int32 location query type integer type description Read type. Can be used by the backend for request handling and logging. enum DEFAULT READ_AHEAD PREFETCH enumDescriptions A regular content read. A read-ahead read (aka cache warming). A prefetching read. location query type string path v1/{+imageProject}/files/{+contentHash} response $ref ReadContentReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write layers methods get description Get the filesystem metadata for an individual layer of an image. flatPath v1/projects/{projectsId}/layers/{layersId} httpMethod GET id containerfilesystem.projects.layers.get parameterOrder imageProject layerId parameters accessToken description Access token used to verify access. Not used in GAE Riptide. location query type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string layerId description The layer ID, e.g. "sha256:abc...def" location path pattern ^[^/]+$ required True type string retryAttempt description Retry attempt number. format int32 location query type integer path v1/{+imageProject}/layers/{+layerId} response $ref LayerReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write prefetch methods get description Get the prefetch list bucket content of a specific image. flatPath v1/projects/{projectsId}/prefetch/{prefetchId} httpMethod GET id containerfilesystem.projects.prefetch.get parameterOrder imageProject filesystemId parameters accessToken description Serialized riptide.PrefetchAccessToken (from AuthImageReply.prefetch_token), encrypted with the server key and base64 encoded. This field is optional and set only if the API authentication is enabled. optional location query type string contextKey description Context key used to distinguish runs of the same image but with different parameters or arguments. location query type string filesystemId description The filesystem identifier, as defined in [MakeFileSystemID](http://google3/apphosting/sandbox/titanium/multi_container.cc?l=425&rcl=327218176). location path pattern ^[^/]+$ required True type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide. location path pattern ^projects/[^/]+$ required True type string path v1/{+imageProject}/prefetch/{+filesystemId} response $ref PrefetchImageReportReply scopes https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/devstorage.read_only https://www.googleapis.com/auth/devstorage.read_write revision 20250131 rootUrl https://containerfilesystem.googleapis.com/ schemas APIBackoffConfig id APIBackoffConfig properties initialInterval description Initial duration for an RPC call retry policy. format google-duration type string maxDuration description Maximum duration for an RPC call retry policy. format google-duration type string maxRetries description Maximum number of retries for an RPC call. format uint64 type string multiplier description Exponential backoff multiplier for an RPC call retry policy. format double type number randomizationFactor description Randomization factor for an RPC call retry policy. format double type number type object AuthImageReply id AuthImageReply properties config $ref Config description The image config (env, port, cmd, ...) retrieved from Riptide Spanner. This will be useful for OnePlatform FUSE to populate the image config blob content as a FUSE file entry, so that `ctr run --rootfs ... --env ...` cmd can be easily executed, without having to perform a GET config blob req. imageId description Riptide image id (digest of the config file for docker schema 2) type string imageProject description Project number hosting the image in the form of 'projects/12345'. This is for VPCSC resource annotation (go/resource-container-guide) and used only by OnePlatform Riptide (Cloud Riptide). Any subsequent RPC calls (GetLayer, ReadContent, GetPrefetchImageReport) should copy this value over to their corresponding request's image_project field. type string layers description A list of layers sorted by position, i.e. the first layer is the top-most layer of the image. The Layer proto also includes the encrypted LayerAccessToken which is required to access the respective layer and files within the layer. items $ref Layer type array prefetchToken description Encrypted and Base64 encoded prefetch token (PrefetchAccessToken protobuf message, serialized and encrypted with the server's key, which is not known to the client) type string serverParameters $ref ServerParameters description These parameters override the default const values or the values provided via command line flags. Parameter's 'scope' defines how it is pushed and how it is applied. The parameter scopes are defined as follows: - 'client' - applies to all features and RPCs of a particular client instance. These parameters are only honored when pushed in the reply of the initial AuthImage probe call. - 'image' - applies to features and RPC issued by particular client instance on the per-image basis.These parameters can be pushed in any AuthImage RPC reply. tokenExpirationTimeMs description Timestamp when the access token expires. format int64 type string type object AuthImageRequest id AuthImageRequest properties clientPlatform $ref ClientPlatform description Architecture and OS AuthImage uses to get the manifest from the manifest list. This is for multiplatform support. imageName description Full image name e.g. gcr.io/my-project/repo/image:tag or gcr.io/my-project/repo/image@digest type string pullSecret description Registry login credential ("(oauth2accesstoken|_json_key(_base64)?):.*") to support GKE imagePullSecrets (http://shortn/_V9ztR0xHVE). Allowed/ supported usernames/passwords are based on http://shortn/_9XF9GH1QIl. Uses RPC EUC if this field is empty. type string retryAttempt description Retry attempt number. format int32 type integer status description Status that indicates the current stage of image caching on GCFSD side. See go/riptide-authimage-heartbeat for more details. enum DEFAULT INITIAL REFRESH CACHED CACHE_DISABLED PROBE enumDescriptions Default value received from old clients that do not distinguish between different AuthImage types. First AuthImageRequest sent for image. Auth refresh heartbeat before image is fully cached. Image has been fully cached by client. The client has cache disabled. Initial server probing. type string type object ClientConfig id ClientConfig properties authImageBackoff $ref APIBackoffConfig description Backoff policy parameters for the AuthImage RPC. The max_duration field is ignored since AuthImage uses a constant backoff policy. policy. enableSingleFlighting description If set, enables/disables the single flighting for an image. type boolean getLayerBackoff $ref APIBackoffConfig description Backoff policy parameters for the GetLayer RPC. readAheadMaxBlocks description If set, enables/disables the read-ahead feature. format int64 type string readContentBackoff $ref APIBackoffConfig description Backoff policy parameters for the ReadContent RPC. type object ClientPlatform id ClientPlatform properties architecture description The architecture used to get the manifest from the manifest list. type string os description The OS used to get the manifest from the manifest list. type string type object Cmd description Defines the command that should be run in the container id Cmd properties args description The arguments to supply the executable items type string type array exec description The executable name (may be resolved with $PATH from Env) required type string type object Config description Configuration for a single container, extracted from the image manifest. This is going to be built with non_prod compatibility, so we should avoid putting any trade secrets in this proto. NEXT TAG: 13 id Config properties architecture description The architecture that the image is built for type string cmd $ref Cmd description The resolved command that should be run command description The CMD of a container. See https://docs.docker.com/engine/reference/builder/#cmd items type string type array dir description The working directory type string entrypoint description The ENTRYPOINT of a container. See https://docs.docker.com/engine/reference/builder/#entrypoint items type string type array env description The environment variables and values to set items $ref Env type array foundVarLog description The image has /var/log directory or not. If yes, the overlay (go/gvisor-overlay) can be configured to /var/log when Logging Fs is mounted at this dir. The overlay will auto-mount any subdirectories recursively under /var/log. type boolean image description The image ID type string labels description A set of labels recorded on the container. This is just raw data coming from the OCI container metadata. items $ref Label type array os description The OS that the image is built for type string port description The network ports to expose items $ref Port type array user description The user[:group] for the command (i.e. the Dockerfile USER, verbatim) type string type object Directory description A (complete) directory in a filesystem layer. id Directory properties entries description Files in this directory. items $ref Entry type array opaque description True if the directory should not be merged with lower layers. type boolean path description The full path to the directory, excluding the leading "/". For example, "/" is the empty string, and "/usr" is represented as "usr". type string type object Entry description A single directory entry in a filesystem layer. id Entry properties name description The name of the directory entry, relative to the directory path. type string stat $ref FileStat description The filesystem metadata for the directory entry. type object Env description Defines an environment variable id Env properties name description Environment variable name, e.g. "PATH" required type string value description Environment variable value, e.g. "/usr/bin:/usr/sbin" type string type object ExtendedAttribute description File extended attributes entry. id ExtendedAttribute properties name type string value format byte type string type object FileBlock description A block of a file in the Riptide filesystem. id FileBlock properties blockData description The block contents. format byte type string blockHash description The SHA256 hexdigest of the block contents. type string lastBlock description Whether the block is the last block in the file. type boolean lowerBound description The lower bound (offset) of the block within the file. Inclusive. format int64 type string upperBound description The upper bound (offset+limit) of the block within the file. Exclusive: the block_data contains the range [lower_bound, upper_bound). format int64 type string type object FileStat description Riptide filesystem metadata for a file. LINT.IfChange id FileStat properties contentHash description SHA256 hexdigest of file contents. type string extendedAttributes description File extended attributes. More info at go/riptide-linux-xattr-support. This may not be populated for the images that do not have xattr support yet. TODO (b/204105260): Change the comment once all the images in Spanner are re-imported with xattr support. items $ref ExtendedAttribute type array gid description GID of file owner. format int32 type integer inlined description Whether the file came from an InlineLayer overlay. type boolean link description Link target (for hard and soft links). type string mode description Linux mode and permission bits. format uint32 type integer mtime description File modification timestamp (microseconds since Unix epoch). format int64 type string size description File size in bytes. format int64 type string uid description UID of file owner. format int32 type integer whiteout description Whether the file is a whiteout. type boolean type object ImageConfig id ImageConfig properties enablePrefetching description If set, enables/disables prefetching for an image. type boolean type object Label description Label is a simple key-value pair. id Label properties key type string value type string type object Layer description Describes a Docker image layer. id Layer properties bytesImported description compared with `layer_info.raw_bytes` to see progress, and can be used in combination with `import_start_time_usec` and the current timestamp to estimate the speed of the layer import. format int64 type string decryptedId description The decrypted layer ID. Populated only if `project_encryption_key_id` is non-empty. type string diffId description The Docker Diff ID (SHA256 digest of the layer tar). V2 schema only. type string digest description The SHA256 digest of the gzip'd layer tar. type string id description The layer ID. If from a v1 schema, this is the digest of the gzip contents. If from a v2 schema, this is the Docker Diff ID. For layers encrypted with a CMEK key, this ID is also encrypted, and `decrypted_id` contains the original layer ID. required type string importFinishTimeUsec description Unix timestamp (in micros) when the layer import completed, or 0 if the import has not completed. format int64 type string importStartTimeUsec description Unix timestamp (in micros) when the layer import started. format int64 type string lastActiveTimeUsec description The last active timestamp of the layer download from Layers.Task if the Layers.Status is not READY, and taken from ProjectLayers.Task otherwise. This determines if we need to restart the download or verification of a layer. format int64 type string layerAccessToken description Encrypted and Base64 encoded Riptide layer access token (LayerAccessToken protobuf message, serialized and encrypted with the server's key, which is not known to the client) type string layerInfo $ref LayerInfo description Various metatadata characterizing the size and contents, and other aspects of the layer. layerStatus description The status taken directly from Layers.Status. This may be READY even if `status` is not. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string mediaType description Layer media type. Empty for image manifest schema 1. type string projectEncryptionKeyId description Project encryption key ID for CMEK. If empty, the layer is not encrypted with a customer managed encryption key. type string projectLayerStatus description The status taken from ProjectLayers.Status. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string provenance description The layer provenance - where this layer came from (if known). enum PROVENANCE_UNKNOWN PROVENANCE_USER PROVENANCE_GOOGLE enumDescriptions Layer provenance is not known. Layer contains user code. Layer was provided by Google, e.g. in a base image. type string status description The status of the layer import (from Layers, or from ProjectLayers if the Layers.Status is READY). If this is READY, the layer is ready for use in the project. enum UNKNOWN ACTIVE READY ERROR HIDDEN enumDescriptions Layer import not started. Layer is currently being imported. Layer has been imported successfully. Layer import attempted, but failed. Not used. type string type object LayerInfo description Various metatadata characterizing the size and contents, and other aspects of a filesystem layer. id LayerInfo properties aiMlMarkers description Markers in the layer that categorize it as an AI/ML layer. items enum UNSPECIFIED CUDA TENSORFLOW enumDescriptions The layer contains CUDA libraries. The layer contains Tensorflow libraries. type string type array directories description The number of directories (both empty and non-empty) in the layer. format uint32 type integer entries description The number of entries in the layer's tar archive. Includes all directories, files, and whiteouts. format uint32 type integer fileBytes description The total number of bytes in all regular files in the layer. format int64 type string filePathSignature description A signature computed by XOR-ing the fingerprint2011 hashes of the file paths of regular files in the layer. format uint64 type string files description The number of regular files (empty and non-empty) in the layer. format uint32 type integer hardLinks description The number of hard links in the layer. format uint32 type integer rawBytes description The number of bytes in the raw (likely gzip compressed) layer blob that was downloaded from the registry at layer import time. format int64 type string softLinks description The number of soft links in the layer. format uint32 type integer tarBytes description The number of bytes in the layer's uncompressed tar archive. format int64 type string whiteouts description The number of whiteouts in the layer. The .wh..wh..opq file (which marks a directory as opaque) is counted as a whiteout (along with any whiteout files with paths like /path/to/.wh.). format uint32 type integer type object LayerReply description RPC response to the request for a Riptide layer. id LayerReply properties directories description The complete list of directories in this layer. items $ref Directory type array projectKeyId description The project key (DEK) identifier, if the layer is encrypted with CMEK. type string type object Port description Defines a TCP or UDP port by protocol and number id Port properties containerPort description The port number within the container's net namespace (0-65535) required format int32 type integer hostPort description The port number outside of the net namespace (if any) (0-65535) format int32 type integer protocol description The protocol (TCP or UDP) required enum PROTO_NONE PROTO_TCP PROTO_UDP enumDescriptions Unknown TCP UDP type string type object PrefetchFileReport description PrefetchFileReport contains one or more reads within the same file. Each read is associated to a file using its file identifier. This allow the server to be able to authorize the client access to the file. id PrefetchFileReport properties fileId description Field used to uniquely identify a file. If the layer_access_token for the layer is set it means that the authentication is enabled; if so the file_id will be the riptide.FileIdentifier encrypted with the layer_encryption key and base64-encoded (more details at go/riptide-auth-design). If the authentication is not enabled this instead will be the file content_hash. type string filePosition description Position within the merged prefetch list of reads executed by the application. format int32 type integer fileSize description File size, as reported by the prefetch recorder based on the SandboxFS. format int64 type string offsets description List of offsets read within the file. Note that reads are aligned at 1MB block sizes. If the list of offsets is empty indicates that the read covers the whole file. items format int64 type string type array type object PrefetchImageReport description LINT.IfChange id PrefetchImageReport properties contextKey description Context key used to distinguish runs of the same image but with different parameters or arguments. type string creationTimestampMicros description Timestamp creation of this report. format int64 type string filesystemId description The filesystem identifier, as defined in [MakeFileSystemID](http://google3/apphosting/sandbox/titanium/multi_container.cc?l=425&rcl=327218176). type string generation description Initially set to 0 indicates that the report is partial. Values greater than 0 indicates a complete report. For more details about how the value changes as a result of a merge process, please refer to the merge logic at http://google3/cloud/containers/riptide/prefetch/prefetch_list_merge.cc. format int64 type string layers description The list of block reads within a layer issued by the container. items $ref PrefetchLayerReport type array version description This field allows to distinguish between different versions of the prefetch list code. This enables the possibility to change the logic and eventually take actions on old reports generated by the previous logic. Set this value to the cl number that changes the logic. The current value is defined in the Recorder library http://google3/cloud/containers/riptide/prefetch/recorder.cc. format int64 type string type object PrefetchImageReportReply description RPC reply for the GetPrefetchImageReport. id PrefetchImageReportReply properties imageReport $ref PrefetchImageReport description The image report requested. type object PrefetchLayerReport id PrefetchLayerReport properties files description List of file reads issued by the client within this layer. items $ref PrefetchFileReport type array layerId description The layer id. type string type object ReadContentReply description RPC response to the request to read from a file in Riptide. id ReadContentReply properties blocks description File blocks that cover the requested offset and length. items $ref FileBlock type array contentHash description The SHA256 hexdigest of the returned file. This can be used to distinguish whether the fileserver was able to return the decrypted version of the requested encrypted content. type string type object ServerParameters id ServerParameters properties clientConfig $ref ClientConfig description ClientConfig is the configuration for all RPCs/features of a particular client instance. It should be set only once and then it stays immutable. imageConfig $ref ImageConfig description ImageConfig is the configuration for customizing features/RPC behavior on per image basis. type object servicePath title Container File System API version v1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/us-west2-dataproc-	values_changed root['revision'] new_value 20250122 old_value 20250131
prod/us-west2-dataproc-v1	dictionary_item_removed root['schemas']['GceClusterConfig']['properties']['resourceManagerTags'] values_changed root['revision'] new_value 20250122 old_value 20250131
prod/us-west2-dataproc-v1beta2	values_changed root['revision'] new_value 20250122 old_value 20250131
prod/us-west2-integrations-v1alpha	dictionary_item_added root['resources']['projects']['resources']['locations']['resources']['integrations']['methods']['executeEvent']['parameters']['GCPCloudEventsMode'] root['schemas']['GoogleCloudConnectorsV1EnrichmentConfig'] root['schemas']['GoogleCloudConnectorsV1EventingConfig']['properties']['enrichmentConfig'] values_changed root['revision'] new_value 20250206 old_value 20250128
prod/us-west2-logging-	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/us-west2-logging-v1	values_changed root['revision'] new_value 20250110 old_value 20250204
prod/us-west2-logging-v2	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/us-west2-logging-v2beta1	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/us-west2-run-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/us-west2-run-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/us-west2-run-v2	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/us-west3-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-artifactregistry-	values_changed root['revision'] new_value 20250204 old_value 20250129
prod/us-west3-artifactregistry-v1beta2	values_changed root['revision'] new_value 20250129 old_value 20250204
prod/us-west3-b-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-b-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-b-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-b-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-b-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-b-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-b-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west3-cloudbuild-	values_changed root['resources']['projects']['resources']['locations']['resources']['connections']['methods']['processWebhook']['parameters']['webhookKey']['description'] new_value Arbitrary additional key to find the matching repository for a webhook event if needed. old_value Arbitrary additional key to find the maching repository for a webhook event if needed. root['revision'] new_value 20250129 old_value 20250117
prod/us-west3-cloudbuild-v1	values_changed root['revision'] new_value 20250129 old_value 20250117
prod/us-west3-cloudbuild-v2	values_changed root['resources']['projects']['resources']['locations']['resources']['connections']['methods']['processWebhook']['parameters']['webhookKey']['description'] new_value Arbitrary additional key to find the matching repository for a webhook event if needed. old_value Arbitrary additional key to find the maching repository for a webhook event if needed. root['revision'] new_value 20250129 old_value 20250117
prod/us-west3-dataproc-v1	dictionary_item_removed root['schemas']['GceClusterConfig']['properties']['resourceManagerTags'] values_changed root['revision'] new_value 20250122 old_value 20250131
prod/us-west3-pubsub-	values_changed root['revision'] new_value 20250128 old_value 20250123
prod/us-west3-pubsub-v1	dictionary_item_added root['schemas']['JavaScriptUDF'] root['schemas']['MessageTransform'] root['schemas']['Subscription']['properties']['messageTransforms'] root['schemas']['Topic']['properties']['messageTransforms'] values_changed root['revision'] new_value 20250128 old_value 20250123
prod/us-west3-pubsub-v1beta2	values_changed root['revision'] new_value 20250128 old_value 20250123
prod/us-west3-workflowexecutions-	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-west3-workflowexecutions-v1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-west3-workflowexecutions-v1alpha1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-west3-workflowexecutions-v1beta	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-west4-a-osconfig-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west4-a-osconfig-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west4-a-osconfig-v1alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west4-a-osconfig-v1beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west4-a-osconfig-v2	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west4-a-osconfig-v2alpha	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west4-a-osconfig-v2beta	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/us-west4-assuredworkloads-	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/us-west4-assuredworkloads-v1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/us-west4-assuredworkloads-v1beta1	values_changed root['revision'] new_value 20250130 old_value 20250123
prod/us-west4-connectgateway-	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/us-west4-connectgateway-v1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/us-west4-connectgateway-v1beta1	values_changed root['revision'] new_value 20250201 old_value 20250127
prod/us-west4-datalineage-	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/us-west4-datalineage-v1	values_changed root['revision'] new_value 20250131 old_value 20250110 iterable_item_added root['endpoints'][19] description Regional Endpoint endpointUrl https://datalineage.europe-west15.rep.googleapis.com/ location europe-west15
prod/us-west4-logging-v1	values_changed root['revision'] new_value 20250204 old_value 20250110
prod/us-west4-monitoring-	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/us-west4-monitoring-v1	dictionary_item_removed root['schemas']['PieChartDataSet']['properties']['breakdowns'] values_changed root['revision'] new_value 20250127 old_value 20250120
prod/us-west4-monitoring-v3	dictionary_item_added root['schemas']['Criteria']['properties']['filter'] values_changed root['revision'] new_value 20250127 old_value 20250120 root['schemas']['Criteria']['properties']['policies']['description'] new_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required if filter is specified at the same time. old_value The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 16 policies per snooze. This limit is checked during snooze creation.
prod/us-west4-workflowexecutions-	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-west4-workflowexecutions-v1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-west4-workflowexecutions-v1alpha1	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/us-west4-workflowexecutions-v1beta	values_changed root['revision'] new_value 20250128 old_value 20250127
prod/versionhistory-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/versionhistory-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/videointelligence-	values_changed root['revision'] new_value 20250130 old_value 20241108
prod/videointelligence-v1beta2	values_changed root['revision'] new_value 20250130 old_value 20241108
prod/videointelligence-v1p2beta1	values_changed root['revision'] new_value 20250130 old_value 20241108
prod/videointelligence-v1p3beta1	values_changed root['revision'] new_value 20250130 old_value 20241108
prod/visionai-v1alpha1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://visionai.googleapis.com/ batchPath batch canonicalName Vision AI description discoveryVersion v1 documentationLink https://cloud.google.com/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id visionai:v1alpha1 kind discovery#restDescription mtlsRootUrl https://visionai.mtls.googleapis.com/ name visionai ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations methods get description Gets information about a location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId} httpMethod GET id visionai.projects.locations.get parameterOrder name parameters name description Resource name for the location. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Location scopes https://www.googleapis.com/auth/cloud-platform list description Lists information about the supported locations for this service. flatPath v1alpha1/projects/{projectsId}/locations httpMethod GET id visionai.projects.locations.list parameterOrder name parameters filter description A 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). location query type string name description The resource that owns the locations collection, if applicable. location path pattern ^projects/[^/]+$ required True type string pageSize description The maximum number of results to return. If not set, the service selects a default. format int32 location query type integer pageToken description A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. location query type string path v1alpha1/{+name}/locations response $ref ListLocationsResponse scopes https://www.googleapis.com/auth/cloud-platform listPublicOperators description ListPublicOperators returns all the operators in public registry. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}:listPublicOperators httpMethod GET id visionai.projects.locations.listPublicOperators parameterOrder parent parameters filter description Filtering results. location query type string orderBy description Hint for how to order the results. location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListPublicOperatorsRequest. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}:listPublicOperators response $ref ListPublicOperatorsResponse scopes https://www.googleapis.com/auth/cloud-platform resolveOperatorInfo description ResolveOperatorInfo returns the operator information based on the request. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}:resolveOperatorInfo httpMethod POST id visionai.projects.locations.resolveOperatorInfo parameterOrder parent parameters parent description Required. Parent value for ResolveOperatorInfoRequest. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}:resolveOperatorInfo request $ref ResolveOperatorInfoRequest response $ref ResolveOperatorInfoResponse scopes https://www.googleapis.com/auth/cloud-platform resources applications methods addStreamInput description Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:addStreamInput httpMethod POST id visionai.projects.locations.applications.addStreamInput parameterOrder name parameters name description Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}" location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+name}:addStreamInput request $ref AddApplicationStreamInputRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform create description Creates a new Application in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications httpMethod POST id visionai.projects.locations.applications.create parameterOrder parent parameters applicationId description Required. Id of the requesting object. location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+parent}/applications request $ref Application response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform createApplicationInstances description Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:createApplicationInstances httpMethod POST id visionai.projects.locations.applications.createApplicationInstances parameterOrder name parameters name description Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}" location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+name}:createApplicationInstances request $ref CreateApplicationInstancesRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId} httpMethod DELETE id visionai.projects.locations.applications.delete parameterOrder name parameters force description Optional. If set to true, any instances and drafts from this application will also be deleted. (Otherwise, the request will only work if the application has no instances and drafts.) location query type boolean name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform deleteApplicationInstances description Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:deleteApplicationInstances httpMethod POST id visionai.projects.locations.applications.deleteApplicationInstances parameterOrder name parameters name description Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}" location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+name}:deleteApplicationInstances request $ref DeleteApplicationInstancesRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform deploy description Deploys a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:deploy httpMethod POST id visionai.projects.locations.applications.deploy parameterOrder name parameters name description Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}" location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+name}:deploy request $ref DeployApplicationRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId} httpMethod GET id visionai.projects.locations.applications.get parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+name} response $ref Application scopes https://www.googleapis.com/auth/cloud-platform list description Lists Applications in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications httpMethod GET id visionai.projects.locations.applications.list parameterOrder parent parameters filter description Filtering results. location query type string orderBy description Hint for how to order the results. location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListApplicationsRequest. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/applications response $ref ListApplicationsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId} httpMethod PATCH id visionai.projects.locations.applications.patch parameterOrder name parameters name description name of resource location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Optional. Field mask is used to specify the fields to be overwritten in the Application resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Application response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform removeStreamInput description Remove target stream input to the Application, if the Application is deployed, the corresponding instance based will be deleted. If the stream is not in the Application, the RPC will fail. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:removeStreamInput httpMethod POST id visionai.projects.locations.applications.removeStreamInput parameterOrder name parameters name description Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}" location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+name}:removeStreamInput request $ref RemoveApplicationStreamInputRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform undeploy description Undeploys a single Application. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:undeploy httpMethod POST id visionai.projects.locations.applications.undeploy parameterOrder name parameters name description Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}" location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+name}:undeploy request $ref UndeployApplicationRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform updateApplicationInstances description Adds target stream input to the Application. If the Application is deployed, the corresponding new Application instance will be created. If the stream has already been in the Application, the RPC will fail. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:updateApplicationInstances httpMethod POST id visionai.projects.locations.applications.updateApplicationInstances parameterOrder name parameters name description Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}" location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+name}:updateApplicationInstances request $ref UpdateApplicationInstancesRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform updateStreamInput description Update target stream input to the Application, if the Application is deployed, the corresponding instance based will be deployed. For CreateOrUpdate behavior, set allow_missing to true. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}:updateStreamInput httpMethod POST id visionai.projects.locations.applications.updateStreamInput parameterOrder name parameters name description Required. the name of the application to retrieve. Format: "projects/{project}/locations/{location}/applications/{application}" location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+name}:updateStreamInput request $ref UpdateApplicationStreamInputRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform resources drafts methods create description Creates a new Draft in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/drafts httpMethod POST id visionai.projects.locations.applications.drafts.create parameterOrder parent parameters draftId description Required. Id of the requesting object. location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+parent}/drafts request $ref Draft response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Draft. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/drafts/{draftsId} httpMethod DELETE id visionai.projects.locations.applications.drafts.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+/drafts/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Draft. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/drafts/{draftsId} httpMethod GET id visionai.projects.locations.applications.drafts.get parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+/drafts/[^/]+$ required True type string path v1alpha1/{+name} response $ref Draft scopes https://www.googleapis.com/auth/cloud-platform list description Lists Drafts in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/drafts httpMethod GET id visionai.projects.locations.applications.drafts.list parameterOrder parent parameters filter description Filtering results. location query type string orderBy description Hint for how to order the results. location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListDraftsRequest. location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+parent}/drafts response $ref ListDraftsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Draft. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/drafts/{draftsId} httpMethod PATCH id visionai.projects.locations.applications.drafts.patch parameterOrder name parameters allowMissing description If true, UpdateDraftRequest will create one resource if the target resource doesn't exist, this time, the field_mask will be ignored. location query type boolean name description name of resource location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+/drafts/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Optional. Field mask is used to specify the fields to be overwritten in the Draft resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Draft response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform instances methods get description Gets details of a single Instance. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/instances/{instancesId} httpMethod GET id visionai.projects.locations.applications.instances.get parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+/instances/[^/]+$ required True type string path v1alpha1/{+name} response $ref Instance scopes https://www.googleapis.com/auth/cloud-platform list description Lists Instances in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/instances httpMethod GET id visionai.projects.locations.applications.instances.list parameterOrder parent parameters filter description Filtering results. location query type string orderBy description Hint for how to order the results. location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListInstancesRequest. location path pattern ^projects/[^/]+/locations/[^/]+/applications/[^/]+$ required True type string path v1alpha1/{+parent}/instances response $ref ListInstancesResponse scopes https://www.googleapis.com/auth/cloud-platform clusters methods channels description Materialize a channel. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/channels httpMethod POST id visionai.projects.locations.clusters.channels parameterOrder parent parameters channelId description Required. Id of the channel. location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+parent}/channels request $ref Channel response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform create description Creates a new Cluster in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters httpMethod POST id visionai.projects.locations.clusters.create parameterOrder parent parameters clusterId description Required. Id of the requesting object. location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+parent}/clusters request $ref Cluster response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Cluster. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId} httpMethod DELETE id visionai.projects.locations.clusters.delete parameterOrder name parameters force description Optional. If set to true, all child resources of the cluster will be deleted. (Otherwise, the request will only work if the cluster has no children.) location query type boolean name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Cluster. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId} httpMethod GET id visionai.projects.locations.clusters.get parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1alpha1/{+name} response $ref Cluster scopes https://www.googleapis.com/auth/cloud-platform getIamPolicy description Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:getIamPolicy httpMethod GET id visionai.projects.locations.clusters.getIamPolicy parameterOrder resource parameters options.requestedPolicyVersion description Optional. 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). format int32 location query type integer resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1alpha1/{+resource}:getIamPolicy response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform healthCheck description HealthCheck method checks the health status of the cluster. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:healthCheck httpMethod GET id visionai.projects.locations.clusters.healthCheck parameterOrder cluster parameters cluster description The parent of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1alpha1/{+cluster}:healthCheck response $ref HealthCheckResponse scopes https://www.googleapis.com/auth/cloud-platform list description Lists Clusters in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters httpMethod GET id visionai.projects.locations.clusters.list parameterOrder parent parameters filter description Filtering results. location query type string orderBy description Hint for how to order the results. location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListClustersRequest. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/clusters response $ref ListClustersResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Cluster. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId} httpMethod PATCH id visionai.projects.locations.clusters.patch parameterOrder name parameters name description Output only. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Cluster response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform setIamPolicy description Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setIamPolicy httpMethod POST id visionai.projects.locations.clusters.setIamPolicy parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1alpha1/{+resource}:setIamPolicy request $ref SetIamPolicyRequest response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform testIamPermissions description Returns 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:testIamPermissions httpMethod POST id visionai.projects.locations.clusters.testIamPermissions parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1alpha1/{+resource}:testIamPermissions request $ref TestIamPermissionsRequest response $ref TestIamPermissionsResponse scopes https://www.googleapis.com/auth/cloud-platform watchEvents description Watch for event updates happening on the given streams. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:watchEvents httpMethod POST id visionai.projects.locations.clusters.watchEvents parameterOrder cluster parameters cluster description The parent of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1alpha1/{+cluster}:watchEvents request $ref WatchEventsRequest response $ref WatchEventsResponse scopes https://www.googleapis.com/auth/cloud-platform resources analyses methods create description Creates a new Analysis in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/analyses httpMethod POST id visionai.projects.locations.clusters.analyses.create parameterOrder parent parameters analysisId description Required. Id of the requesting object. location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+parent}/analyses request $ref Analysis response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Analysis. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/analyses/{analysesId} httpMethod DELETE id visionai.projects.locations.clusters.analyses.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/analyses/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Analysis. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/analyses/{analysesId} httpMethod GET id visionai.projects.locations.clusters.analyses.get parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/analyses/[^/]+$ required True type string path v1alpha1/{+name} response $ref Analysis scopes https://www.googleapis.com/auth/cloud-platform getIamPolicy description Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/analyses/{analysesId}:getIamPolicy httpMethod GET id visionai.projects.locations.clusters.analyses.getIamPolicy parameterOrder resource parameters options.requestedPolicyVersion description Optional. 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). format int32 location query type integer resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/analyses/[^/]+$ required True type string path v1alpha1/{+resource}:getIamPolicy response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform list description Lists Analyses in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/analyses httpMethod GET id visionai.projects.locations.clusters.analyses.list parameterOrder parent parameters filter description Filtering results location query type string orderBy description Hint for how to order the results location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListAnalysesRequest location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1alpha1/{+parent}/analyses response $ref ListAnalysesResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Analysis. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/analyses/{analysesId} httpMethod PATCH id visionai.projects.locations.clusters.analyses.patch parameterOrder name parameters name description The name of resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/analyses/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the Analysis resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Analysis response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform setIamPolicy description Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/analyses/{analysesId}:setIamPolicy httpMethod POST id visionai.projects.locations.clusters.analyses.setIamPolicy parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/analyses/[^/]+$ required True type string path v1alpha1/{+resource}:setIamPolicy request $ref SetIamPolicyRequest response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform testIamPermissions description Returns 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/analyses/{analysesId}:testIamPermissions httpMethod POST id visionai.projects.locations.clusters.analyses.testIamPermissions parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/analyses/[^/]+$ required True type string path v1alpha1/{+resource}:testIamPermissions request $ref TestIamPermissionsRequest response $ref TestIamPermissionsResponse scopes https://www.googleapis.com/auth/cloud-platform events methods create description Creates a new Event in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/events httpMethod POST id visionai.projects.locations.clusters.events.create parameterOrder parent parameters eventId description Required. Id of the requesting object. location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+parent}/events request $ref Event response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Event. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/events/{eventsId} httpMethod DELETE id visionai.projects.locations.clusters.events.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/events/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Event. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/events/{eventsId} httpMethod GET id visionai.projects.locations.clusters.events.get parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/events/[^/]+$ required True type string path v1alpha1/{+name} response $ref Event scopes https://www.googleapis.com/auth/cloud-platform getIamPolicy description Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/events/{eventsId}:getIamPolicy httpMethod GET id visionai.projects.locations.clusters.events.getIamPolicy parameterOrder resource parameters options.requestedPolicyVersion description Optional. 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). format int32 location query type integer resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/events/[^/]+$ required True type string path v1alpha1/{+resource}:getIamPolicy response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform list description Lists Events in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/events httpMethod GET id visionai.projects.locations.clusters.events.list parameterOrder parent parameters filter description Filtering results. location query type string orderBy description Hint for how to order the results. location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListEventsRequest. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1alpha1/{+parent}/events response $ref ListEventsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Event. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/events/{eventsId} httpMethod PATCH id visionai.projects.locations.clusters.events.patch parameterOrder name parameters name description Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/events/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the Event resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Event response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform setIamPolicy description Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/events/{eventsId}:setIamPolicy httpMethod POST id visionai.projects.locations.clusters.events.setIamPolicy parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/events/[^/]+$ required True type string path v1alpha1/{+resource}:setIamPolicy request $ref SetIamPolicyRequest response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform testIamPermissions description Returns 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/events/{eventsId}:testIamPermissions httpMethod POST id visionai.projects.locations.clusters.events.testIamPermissions parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/events/[^/]+$ required True type string path v1alpha1/{+resource}:testIamPermissions request $ref TestIamPermissionsRequest response $ref TestIamPermissionsResponse scopes https://www.googleapis.com/auth/cloud-platform processes methods batchRun description Run all of the processes to "completion". Max time for each process is the LRO time limit. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/processes:batchRun httpMethod POST id visionai.projects.locations.clusters.processes.batchRun parameterOrder parent parameters parent description Required. The parent resource shared by all processes being created. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1alpha1/{+parent}/processes:batchRun request $ref BatchRunProcessRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform create description Creates a new Process in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/processes httpMethod POST id visionai.projects.locations.clusters.processes.create parameterOrder parent parameters parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string processId description Required. Id of the requesting object. location query type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+parent}/processes request $ref Process response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Process. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/processes/{processesId} httpMethod DELETE id visionai.projects.locations.clusters.processes.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/processes/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Process. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/processes/{processesId} httpMethod GET id visionai.projects.locations.clusters.processes.get parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/processes/[^/]+$ required True type string path v1alpha1/{+name} response $ref Process scopes https://www.googleapis.com/auth/cloud-platform list description Lists Processes in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/processes httpMethod GET id visionai.projects.locations.clusters.processes.list parameterOrder parent parameters filter description Filtering results location query type string orderBy description Hint for how to order the results location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListProcessesRequest. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1alpha1/{+parent}/processes response $ref ListProcessesResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Process. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/processes/{processesId} httpMethod PATCH id visionai.projects.locations.clusters.processes.patch parameterOrder name parameters name description The name of resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/processes/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the Process resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Process response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform series methods acquireLease description AcquireLease acquires a lease. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/series/{seriesId}:acquireLease httpMethod POST id visionai.projects.locations.clusters.series.acquireLease parameterOrder series parameters series description The series name. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/series/[^/]+$ required True type string path v1alpha1/{+series}:acquireLease request $ref AcquireLeaseRequest response $ref Lease scopes https://www.googleapis.com/auth/cloud-platform create description Creates a new Series in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/series httpMethod POST id visionai.projects.locations.clusters.series.create parameterOrder parent parameters parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string seriesId description Required. Id of the requesting object. location query type string path v1alpha1/{+parent}/series request $ref Series response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Series. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/series/{seriesId} httpMethod DELETE id visionai.projects.locations.clusters.series.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/series/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Series. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/series/{seriesId} httpMethod GET id visionai.projects.locations.clusters.series.get parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/series/[^/]+$ required True type string path v1alpha1/{+name} response $ref Series scopes https://www.googleapis.com/auth/cloud-platform getIamPolicy description Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/series/{seriesId}:getIamPolicy httpMethod GET id visionai.projects.locations.clusters.series.getIamPolicy parameterOrder resource parameters options.requestedPolicyVersion description Optional. 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). format int32 location query type integer resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/series/[^/]+$ required True type string path v1alpha1/{+resource}:getIamPolicy response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform list description Lists Series in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/series httpMethod GET id visionai.projects.locations.clusters.series.list parameterOrder parent parameters filter description Filtering results. location query type string orderBy description Hint for how to order the results. location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListSeriesRequest. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1alpha1/{+parent}/series response $ref ListSeriesResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Event. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/series/{seriesId} httpMethod PATCH id visionai.projects.locations.clusters.series.patch parameterOrder name parameters name description Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/series/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the Series resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Series response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform releaseLease description RleaseLease releases a lease. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/series/{seriesId}:releaseLease httpMethod POST id visionai.projects.locations.clusters.series.releaseLease parameterOrder series parameters series description Series name. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/series/[^/]+$ required True type string path v1alpha1/{+series}:releaseLease request $ref ReleaseLeaseRequest response $ref ReleaseLeaseResponse scopes https://www.googleapis.com/auth/cloud-platform renewLease description RenewLease renews a lease. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/series/{seriesId}:renewLease httpMethod POST id visionai.projects.locations.clusters.series.renewLease parameterOrder series parameters series description Series name. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/series/[^/]+$ required True type string path v1alpha1/{+series}:renewLease request $ref RenewLeaseRequest response $ref Lease scopes https://www.googleapis.com/auth/cloud-platform setIamPolicy description Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/series/{seriesId}:setIamPolicy httpMethod POST id visionai.projects.locations.clusters.series.setIamPolicy parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/series/[^/]+$ required True type string path v1alpha1/{+resource}:setIamPolicy request $ref SetIamPolicyRequest response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform testIamPermissions description Returns 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/series/{seriesId}:testIamPermissions httpMethod POST id visionai.projects.locations.clusters.series.testIamPermissions parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/series/[^/]+$ required True type string path v1alpha1/{+resource}:testIamPermissions request $ref TestIamPermissionsRequest response $ref TestIamPermissionsResponse scopes https://www.googleapis.com/auth/cloud-platform streams methods create description Creates a new Stream in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/streams httpMethod POST id visionai.projects.locations.clusters.streams.create parameterOrder parent parameters parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string streamId description Required. Id of the requesting object. location query type string path v1alpha1/{+parent}/streams request $ref Stream response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Stream. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/streams/{streamsId} httpMethod DELETE id visionai.projects.locations.clusters.streams.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/streams/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform generateStreamHlsToken description Generate the JWT auth token required to get the stream HLS contents. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/streams/{streamsId}:generateStreamHlsToken httpMethod POST id visionai.projects.locations.clusters.streams.generateStreamHlsToken parameterOrder stream parameters stream description Required. The name of the stream. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/streams/[^/]+$ required True type string path v1alpha1/{+stream}:generateStreamHlsToken request $ref GenerateStreamHlsTokenRequest response $ref GenerateStreamHlsTokenResponse scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Stream. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/streams/{streamsId} httpMethod GET id visionai.projects.locations.clusters.streams.get parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/streams/[^/]+$ required True type string path v1alpha1/{+name} response $ref Stream scopes https://www.googleapis.com/auth/cloud-platform getIamPolicy description Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/streams/{streamsId}:getIamPolicy httpMethod GET id visionai.projects.locations.clusters.streams.getIamPolicy parameterOrder resource parameters options.requestedPolicyVersion description Optional. 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). format int32 location query type integer resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/streams/[^/]+$ required True type string path v1alpha1/{+resource}:getIamPolicy response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform list description Lists Streams in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/streams httpMethod GET id visionai.projects.locations.clusters.streams.list parameterOrder parent parameters filter description Filtering results. location query type string orderBy description Hint for how to order the results. location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListStreamsRequest. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$ required True type string path v1alpha1/{+parent}/streams response $ref ListStreamsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Stream. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/streams/{streamsId} httpMethod PATCH id visionai.projects.locations.clusters.streams.patch parameterOrder name parameters name description Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/streams/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the Stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Stream response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform setIamPolicy description Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/streams/{streamsId}:setIamPolicy httpMethod POST id visionai.projects.locations.clusters.streams.setIamPolicy parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/streams/[^/]+$ required True type string path v1alpha1/{+resource}:setIamPolicy request $ref SetIamPolicyRequest response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform testIamPermissions description Returns 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/streams/{streamsId}:testIamPermissions httpMethod POST id visionai.projects.locations.clusters.streams.testIamPermissions parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/clusters/[^/]+/streams/[^/]+$ required True type string path v1alpha1/{+resource}:testIamPermissions request $ref TestIamPermissionsRequest response $ref TestIamPermissionsResponse scopes https://www.googleapis.com/auth/cloud-platform corpora methods analyze description Analyzes a corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}:analyze httpMethod POST id visionai.projects.locations.corpora.analyze parameterOrder name parameters name description Required. The parent corpus resource where the assets will be analyzed. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+name}:analyze request $ref AnalyzeCorpusRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform create description Creates a corpus inside a project. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora httpMethod POST id visionai.projects.locations.corpora.create parameterOrder parent parameters parent description Required. Form: `projects/{project_number}/locations/{location_id}` location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/corpora request $ref Corpus response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a corpus only if its empty. Returns empty response. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId} httpMethod DELETE id visionai.projects.locations.corpora.delete parameterOrder name parameters name description Required. The resource name of the corpus to delete. location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets corpus details inside a project. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId} httpMethod GET id visionai.projects.locations.corpora.get parameterOrder name parameters name description Required. The resource name of the corpus to retrieve. location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+name} response $ref Corpus scopes https://www.googleapis.com/auth/cloud-platform list description Lists all corpora in a project. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora httpMethod GET id visionai.projects.locations.corpora.list parameterOrder parent parameters filter description The filter applied to the returned corpora list. Only the following restrictions are supported: `type=`, `type!=`. location query type string pageSize description Requested page size. API may return fewer results than requested. If negative, INVALID_ARGUMENT error will be returned. If unspecified or 0, API will pick a default size, which is 10. If the requested page size is larger than the maximum size, API will pick use the maximum size, which is 20. format int32 location query type integer pageToken description A token identifying a page of results for the server to return. Typically obtained via ListCorporaResponse.next_page_token of the previous Warehouse.ListCorpora call. location query type string parent description Required. The resource name of the project from which to list corpora. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/corpora response $ref ListCorporaResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates a corpus in a project. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId} httpMethod PATCH id visionai.projects.locations.corpora.patch parameterOrder name parameters name description Resource name of the corpus. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string updateMask description The list of fields to be updated. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Corpus response $ref Corpus scopes https://www.googleapis.com/auth/cloud-platform searchAssets description Search media asset. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}:searchAssets httpMethod POST id visionai.projects.locations.corpora.searchAssets parameterOrder corpus parameters corpus description Required. The parent corpus to search. Format: `projects/{project_id}/locations/{location_id}/corpora/{corpus_id}' location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+corpus}:searchAssets request $ref SearchAssetsRequest response $ref SearchAssetsResponse scopes https://www.googleapis.com/auth/cloud-platform resources assets methods analyze description Analyze asset to power search capability. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}:analyze httpMethod POST id visionai.projects.locations.corpora.assets.analyze parameterOrder name parameters name description Required. The resource name of the asset to analyze. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+$ required True type string path v1alpha1/{+name}:analyze request $ref AnalyzeAssetRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform clip description Generates clips for downloading. The api takes in a time range, and generates a clip of the first content available after start_time and before end_time, which may overflow beyond these bounds. Returned clips are truncated if the total size of the clips are larger than 100MB. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}:clip httpMethod POST id visionai.projects.locations.corpora.assets.clip parameterOrder name parameters name description Required. The resource name of the asset to request clips for. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+$ required True type string path v1alpha1/{+name}:clip request $ref ClipAssetRequest response $ref ClipAssetResponse scopes https://www.googleapis.com/auth/cloud-platform create description Creates an asset inside corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets httpMethod POST id visionai.projects.locations.corpora.assets.create parameterOrder parent parameters assetId description Optional. The ID to use for the asset, which will become the final component of the asset's resource name if user choose to specify. Otherwise, asset id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number. location query type string parent description Required. The parent resource where this asset will be created. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+parent}/assets request $ref Asset response $ref Asset scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes asset inside corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId} httpMethod DELETE id visionai.projects.locations.corpora.assets.delete parameterOrder name parameters name description Required. The name of the asset to delete. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform generateHlsUri description Generates a uri for an HLS manifest. The api takes in a collection of time ranges, and generates a URI for an HLS manifest that covers all the requested time ranges. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}:generateHlsUri httpMethod POST id visionai.projects.locations.corpora.assets.generateHlsUri parameterOrder name parameters name description Required. The resource name of the asset to request clips for. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+$ required True type string path v1alpha1/{+name}:generateHlsUri request $ref GenerateHlsUriRequest response $ref GenerateHlsUriResponse scopes https://www.googleapis.com/auth/cloud-platform generateRetrievalUrl description Generates a signed url for downloading the asset. For video warehouse, please see comment of UploadAsset about how to allow retrieval of cloud storage files in a different project. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}:generateRetrievalUrl httpMethod POST id visionai.projects.locations.corpora.assets.generateRetrievalUrl parameterOrder name parameters name description Required. The resource name of the asset to request signed url for. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+$ required True type string path v1alpha1/{+name}:generateRetrievalUrl request $ref GenerateRetrievalUrlRequest response $ref GenerateRetrievalUrlResponse scopes https://www.googleapis.com/auth/cloud-platform get description Reads an asset inside corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId} httpMethod GET id visionai.projects.locations.corpora.assets.get parameterOrder name parameters name description Required. The name of the asset to retrieve. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset} location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+$ required True type string path v1alpha1/{+name} response $ref Asset scopes https://www.googleapis.com/auth/cloud-platform import description Imports assets (images plus annotations) from a meta file on cloud storage. Each row in the meta file is corresponding to an image (specified by a cloud storage uri) and its annotations. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets:import httpMethod POST id visionai.projects.locations.corpora.assets.import parameterOrder parent parameters parent description Required. The parent corpus resource where the assets will be imported. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+parent}/assets:import request $ref ImportAssetsRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform index description Index one asset for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}:index httpMethod POST id visionai.projects.locations.corpora.assets.index parameterOrder name parameters name description Required. The resource name of the asset to index. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+$ required True type string path v1alpha1/{+name}:index request $ref IndexAssetRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists an list of assets inside corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets httpMethod GET id visionai.projects.locations.corpora.assets.list parameterOrder parent parameters filter description The filter applied to the returned list. Only the following filterings are supported: "assets_with_contents = true", which returns assets with contents uploaded; "assets_with_contents = false", which returns assets without contents. location query type string pageSize description The maximum number of assets to return. The service may return fewer than this value. If unspecified, at most 50 assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. format int32 location query type integer pageToken description A page token, received from a previous `ListAssets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAssets` must match the call that provided the page token. location query type string parent description Required. The parent, which owns this collection of assets. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+parent}/assets response $ref ListAssetsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates an asset inside corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId} httpMethod PATCH id visionai.projects.locations.corpora.assets.patch parameterOrder name parameters name description Resource name of the asset. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+$ required True type string updateMask description The list of fields to be updated. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Asset response $ref Asset scopes https://www.googleapis.com/auth/cloud-platform removeIndex description Remove one asset's index data for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}:removeIndex httpMethod POST id visionai.projects.locations.corpora.assets.removeIndex parameterOrder name parameters name description Required. The resource name of the asset to index. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+$ required True type string path v1alpha1/{+name}:removeIndex request $ref RemoveIndexAssetRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform upload description Upload asset by specifing the asset Cloud Storage uri. For video warehouse, it requires users who call this API have read access to the cloud storage file. Once it is uploaded, it can be retrieved by GenerateRetrievalUrl API which by default, only can retrieve cloud storage files from the same project of the warehouse. To allow retrieval cloud storage files that are in a separate project, it requires to find the vision ai service account (Go to IAM, check checkbox to show "Include Google-provided role grants", search for "Cloud Vision AI Service Agent") and grant the read access of the cloud storage files to that service account. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}:upload httpMethod POST id visionai.projects.locations.corpora.assets.upload parameterOrder name parameters name description Required. The resource name of the asset to upload. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+$ required True type string path v1alpha1/{+name}:upload request $ref UploadAssetRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform resources annotations methods create description Creates annotation inside asset. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}/annotations httpMethod POST id visionai.projects.locations.corpora.assets.annotations.create parameterOrder parent parameters annotationId description Optional. The ID to use for the annotation, which will become the final component of the annotation's resource name if user choose to specify. Otherwise, annotation id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number. location query type string parent description Required. The parent resource where this annotation will be created. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+$ required True type string path v1alpha1/{+parent}/annotations request $ref Annotation response $ref Annotation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes annotation inside asset. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}/annotations/{annotationsId} httpMethod DELETE id visionai.projects.locations.corpora.assets.annotations.delete parameterOrder name parameters name description Required. The name of the annotation to delete. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+/annotations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Reads annotation inside asset. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}/annotations/{annotationsId} httpMethod GET id visionai.projects.locations.corpora.assets.annotations.get parameterOrder name parameters name description Required. The name of the annotation to retrieve. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+/annotations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Annotation scopes https://www.googleapis.com/auth/cloud-platform list description Lists a list of annotations inside asset. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}/annotations httpMethod GET id visionai.projects.locations.corpora.assets.annotations.list parameterOrder parent parameters filter description The filter applied to the returned list. We only support filtering for the following fields: `partition.temporal_partition.start_time`, `partition.temporal_partition.end_time`, and `key`. For corpus of IMAGE type, only `key` is supported. Timestamps are specified in the RFC-3339 format, and only one restriction may be applied per field, joined by conjunctions. Format: "partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND key = "example_key"" location query type string pageSize description The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. format int32 location query type integer pageToken description A page token, received from a previous `ListAnnotations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnnotations` must match the call that provided the page token. location query type string parent description The parent, which owns this collection of annotations. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+$ required True type string path v1alpha1/{+parent}/annotations response $ref ListAnnotationsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates annotation inside asset. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}/annotations/{annotationsId} httpMethod PATCH id visionai.projects.locations.corpora.assets.annotations.patch parameterOrder name parameters name description Resource name of the annotation. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+/annotations/[^/]+$ required True type string updateMask description The list of fields to be updated. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Annotation response $ref Annotation scopes https://www.googleapis.com/auth/cloud-platform operations methods get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/assets/{assetsId}/operations/{operationsId} httpMethod GET id visionai.projects.locations.corpora.assets.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/assets/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform collections methods addCollectionItem description Adds an item into a Collection. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/collections/{collectionsId}:addCollectionItem httpMethod POST id visionai.projects.locations.corpora.collections.addCollectionItem parameterOrder collection parameters collection description Required. The collection name that this item belongs to. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/collections/[^/]+$ required True type string path v1alpha1/{+collection}:addCollectionItem request $ref AddCollectionItemRequest response $ref AddCollectionItemResponse scopes https://www.googleapis.com/auth/cloud-platform create description Creates a collection. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/collections httpMethod POST id visionai.projects.locations.corpora.collections.create parameterOrder parent parameters collectionId description Optional. The ID to use for the collection, which will become the final component of the resource name if user choose to specify. Otherwise, collection id will be generated by system. This value should be up to 55 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number. location query type string parent description Required. The parent resource where this collection will be created. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+parent}/collections request $ref Collection response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a collection. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/collections/{collectionsId} httpMethod DELETE id visionai.projects.locations.corpora.collections.delete parameterOrder name parameters name description Required. The name of the collection to delete. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/collections/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets a collection. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/collections/{collectionsId} httpMethod GET id visionai.projects.locations.corpora.collections.get parameterOrder name parameters name description Required. The name of the collection to retrieve. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/collections/[^/]+$ required True type string path v1alpha1/{+name} response $ref Collection scopes https://www.googleapis.com/auth/cloud-platform list description Lists collections inside a corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/collections httpMethod GET id visionai.projects.locations.corpora.collections.list parameterOrder parent parameters pageSize description The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. format int32 location query type integer pageToken description A page token, received from a previous `ListCollectionsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCollectionsRequest` must match the call that provided the page token. location query type string parent description Required. The parent corpus. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+parent}/collections response $ref ListCollectionsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates a collection. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/collections/{collectionsId} httpMethod PATCH id visionai.projects.locations.corpora.collections.patch parameterOrder name parameters name description Output only. Resource name of the collection. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/collections/[^/]+$ required True type string updateMask description The list of fields to be updated. - Unset `update_mask` or set `update_mask` to be a single "*" only will update all updatable fields with the value provided in `collection`. - To update `display_name` value to empty string, set it in the `collection` to empty string, and set `update_mask` with "display_name". Same applies to other updatable string fields in the `collection`. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Collection response $ref Collection scopes https://www.googleapis.com/auth/cloud-platform removeCollectionItem description Removes an item from a collection. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/collections/{collectionsId}:removeCollectionItem httpMethod POST id visionai.projects.locations.corpora.collections.removeCollectionItem parameterOrder collection parameters collection description Required. The collection name that this item belongs to. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/collections/[^/]+$ required True type string path v1alpha1/{+collection}:removeCollectionItem request $ref RemoveCollectionItemRequest response $ref RemoveCollectionItemResponse scopes https://www.googleapis.com/auth/cloud-platform viewCollectionItems description View items inside a collection. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/collections/{collectionsId}:viewCollectionItems httpMethod GET id visionai.projects.locations.corpora.collections.viewCollectionItems parameterOrder collection parameters collection description Required. The collection to view. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/collections/[^/]+$ required True type string pageSize description The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. format int32 location query type integer pageToken description A page token, received from a previous `ViewCollectionItemsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ViewCollectionItemsRequest` must match the call that provided the page token. location query type string path v1alpha1/{+collection}:viewCollectionItems response $ref ViewCollectionItemsResponse scopes https://www.googleapis.com/auth/cloud-platform resources operations methods get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/collections/{collectionsId}/operations/{operationsId} httpMethod GET id visionai.projects.locations.corpora.collections.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/collections/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform dataSchemas methods create description Creates data schema inside corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/dataSchemas httpMethod POST id visionai.projects.locations.corpora.dataSchemas.create parameterOrder parent parameters parent description Required. The parent resource where this data schema will be created. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+parent}/dataSchemas request $ref DataSchema response $ref DataSchema scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes data schema inside corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/dataSchemas/{dataSchemasId} httpMethod DELETE id visionai.projects.locations.corpora.dataSchemas.delete parameterOrder name parameters name description Required. The name of the data schema to delete. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/dataSchemas/{data_schema_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/dataSchemas/[^/]+$ required True type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets data schema inside corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/dataSchemas/{dataSchemasId} httpMethod GET id visionai.projects.locations.corpora.dataSchemas.get parameterOrder name parameters name description Required. The name of the data schema to retrieve. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/dataSchemas/{data_schema_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/dataSchemas/[^/]+$ required True type string path v1alpha1/{+name} response $ref DataSchema scopes https://www.googleapis.com/auth/cloud-platform list description Lists a list of data schemas inside corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/dataSchemas httpMethod GET id visionai.projects.locations.corpora.dataSchemas.list parameterOrder parent parameters pageSize description The maximum number of data schemas to return. The service may return fewer than this value. If unspecified, at most 50 data schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. format int32 location query type integer pageToken description A page token, received from a previous `ListDataSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSchemas` must match the call that provided the page token. location query type string parent description Required. The parent, which owns this collection of data schemas. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+parent}/dataSchemas response $ref ListDataSchemasResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates data schema inside corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/dataSchemas/{dataSchemasId} httpMethod PATCH id visionai.projects.locations.corpora.dataSchemas.patch parameterOrder name parameters name description Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema}` where {data_schema} part should be the same as the `key` field below. location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/dataSchemas/[^/]+$ required True type string updateMask description The list of fields to be updated. format google-fieldmask location query type string path v1alpha1/{+name} request $ref DataSchema response $ref DataSchema scopes https://www.googleapis.com/auth/cloud-platform imageIndexes resources operations methods get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/imageIndexes/{imageIndexesId}/operations/{operationsId} httpMethod GET id visionai.projects.locations.corpora.imageIndexes.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/imageIndexes/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform indexes methods create description Creates an Index under the corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/indexes httpMethod POST id visionai.projects.locations.corpora.indexes.create parameterOrder parent parameters indexId description Optional. The ID for the index. This will become the final resource name for the index. If the user does not specify this value, it will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number. location query type string parent description Required. Value for the parent. The resource name of the Corpus under which this index is created. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+parent}/indexes request $ref Index response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Delete a single Index. In order to delete an index, the caller must make sure that it is not deployed to any index endpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/indexes/{indexesId} httpMethod DELETE id visionai.projects.locations.corpora.indexes.delete parameterOrder name parameters name description Required. The name of the index to delete. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/indexes/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets the details of a single Index under a Corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/indexes/{indexesId} httpMethod GET id visionai.projects.locations.corpora.indexes.get parameterOrder name parameters name description Required. Name of the Index resource. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/indexes/[^/]+$ required True type string path v1alpha1/{+name} response $ref Index scopes https://www.googleapis.com/auth/cloud-platform list description List all Indexes in a given Corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/indexes httpMethod GET id visionai.projects.locations.corpora.indexes.list parameterOrder parent parameters pageSize description The maximum number of indexes to return. The service may return fewer than this value. If unspecified, at most 50 indexes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. format int32 location query type integer pageToken description A page token, received from a previous `ListIndexes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIndexes` must match the call that provided the page token. location query type string parent description Required. The parent corpus that owns this collection of indexes. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+parent}/indexes response $ref ListIndexesResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates an Index under the corpus. Users can perform a metadata-only update or trigger a full index rebuild with different update_mask values. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/indexes/{indexesId} httpMethod PATCH id visionai.projects.locations.corpora.indexes.patch parameterOrder name parameters name description Output only. Resource name of the Index resource. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/indexes/[^/]+$ required True type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the Index resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field of the resource will be overwritten if it is in the mask. Empty field mask is not allowed. If the mask is "*", it triggers a full update of the index, and also a whole rebuild of index data. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Index response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform viewAssets description Lists assets inside an index. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/indexes/{indexesId}:viewAssets httpMethod GET id visionai.projects.locations.corpora.indexes.viewAssets parameterOrder index parameters filter description The filter applied to the returned list. Only the following filterings are supported: "asset_id = xxxx", which returns asset with specified id. "asset_id = xxxx, yyyy, zzzz", which returns assets with specified ids. location query type string index description Required. The index that owns this collection of assets. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/indexes/[^/]+$ required True type string pageSize description The maximum number of assets to return. The service may return fewer than this value. If unspecified, at most 50 assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. format int32 location query type integer pageToken description A page token, received from a previous `ViewIndexedAssets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ViewIndexedAssets` must match the call that provided the page token. location query type string path v1alpha1/{+index}:viewAssets response $ref ViewIndexedAssetsResponse scopes https://www.googleapis.com/auth/cloud-platform resources operations methods get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/indexes/{indexesId}/operations/{operationsId} httpMethod GET id visionai.projects.locations.corpora.indexes.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/indexes/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform operations methods get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/operations/{operationsId} httpMethod GET id visionai.projects.locations.corpora.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform searchConfigs methods create description Creates a search configuration inside a corpus. Please follow the rules below to create a valid CreateSearchConfigRequest. --- General Rules --- 1. Request.search_config_id must not be associated with an existing SearchConfig. 2. Request must contain at least one non-empty search_criteria_property or facet_property. 3. mapped_fields must not be empty, and must map to existing UGA keys. 4. All mapped_fields must be of the same type. 5. All mapped_fields must share the same granularity. 6. All mapped_fields must share the same semantic SearchConfig match options. For property-specific rules, please reference the comments for FacetProperty and SearchCriteriaProperty. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/searchConfigs httpMethod POST id visionai.projects.locations.corpora.searchConfigs.create parameterOrder parent parameters parent description Required. The parent resource where this search configuration will be created. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string searchConfigId description Required. ID to use for the new search config. Will become the final component of the SearchConfig's resource name. This value should be up to 63 characters, and valid characters are /a-z-_/. The first character must be a letter, the last could be a letter or a number. location query type string path v1alpha1/{+parent}/searchConfigs request $ref SearchConfig response $ref SearchConfig scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a search configuration inside a corpus. For a DeleteSearchConfigRequest to be valid, Request.search_configuration.name must already exist. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/searchConfigs/{searchConfigsId} httpMethod DELETE id visionai.projects.locations.corpora.searchConfigs.delete parameterOrder name parameters name description Required. The name of the search configuration to delete. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/searchConfigs/[^/]+$ required True type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets a search configuration inside a corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/searchConfigs/{searchConfigsId} httpMethod GET id visionai.projects.locations.corpora.searchConfigs.get parameterOrder name parameters name description Required. The name of the search configuration to retrieve. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/searchConfigs/[^/]+$ required True type string path v1alpha1/{+name} response $ref SearchConfig scopes https://www.googleapis.com/auth/cloud-platform list description Lists all search configurations inside a corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/searchConfigs httpMethod GET id visionai.projects.locations.corpora.searchConfigs.list parameterOrder parent parameters pageSize description The maximum number of search configurations to return. The service may return fewer than this value. If unspecified, a page size of 50 will be used. The maximum value is 1000; values above 1000 will be coerced to 1000. format int32 location query type integer pageToken description A page token, received from a previous `ListSearchConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSearchConfigs` must match the call that provided the page token. location query type string parent description Required. The parent, which owns this collection of search configurations. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+parent}/searchConfigs response $ref ListSearchConfigsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates a search configuration inside a corpus. Please follow the rules below to create a valid UpdateSearchConfigRequest. --- General Rules --- 1. Request.search_configuration.name must already exist. 2. Request must contain at least one non-empty search_criteria_property or facet_property. 3. mapped_fields must not be empty, and must map to existing UGA keys. 4. All mapped_fields must be of the same type. 5. All mapped_fields must share the same granularity. 6. All mapped_fields must share the same semantic SearchConfig match options. For property-specific rules, please reference the comments for FacetProperty and SearchCriteriaProperty. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/searchConfigs/{searchConfigsId} httpMethod PATCH id visionai.projects.locations.corpora.searchConfigs.patch parameterOrder name parameters name description Resource name of the search configuration. For CustomSearchCriteria, search_config would be the search operator name. For Facets, search_config would be the facet dimension name. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/searchConfigs/[^/]+$ required True type string updateMask description The list of fields to be updated. If left unset, all field paths will be updated/overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref SearchConfig response $ref SearchConfig scopes https://www.googleapis.com/auth/cloud-platform searchHypernyms methods create description Creates a SearchHypernym inside a corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/searchHypernyms httpMethod POST id visionai.projects.locations.corpora.searchHypernyms.create parameterOrder parent parameters parent description Required. The parent resource where this SearchHypernym will be created. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string searchHypernymId description Optional. The search hypernym id. If omitted, a random UUID will be generated. location query type string path v1alpha1/{+parent}/searchHypernyms request $ref SearchHypernym response $ref SearchHypernym scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a SearchHypernym inside a corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/searchHypernyms/{searchHypernymsId} httpMethod DELETE id visionai.projects.locations.corpora.searchHypernyms.delete parameterOrder name parameters name description Required. The name of the SearchHypernym to delete. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/searchHypernyms/[^/]+$ required True type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets a SearchHypernym inside a corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/searchHypernyms/{searchHypernymsId} httpMethod GET id visionai.projects.locations.corpora.searchHypernyms.get parameterOrder name parameters name description Required. The name of the SearchHypernym to retrieve. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/searchHypernyms/[^/]+$ required True type string path v1alpha1/{+name} response $ref SearchHypernym scopes https://www.googleapis.com/auth/cloud-platform list description Lists SearchHypernyms inside a corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/searchHypernyms httpMethod GET id visionai.projects.locations.corpora.searchHypernyms.list parameterOrder parent parameters pageSize description The maximum number of SearchHypernyms returned. The service may return fewer than this value. If unspecified, a page size of 50 will be used. The maximum value is 1000; values above 1000 will be coerced to 1000. format int32 location query type integer pageToken description A page token, received from a previous `SearchHypernym` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchHypernym` must match the call that provided the page token. location query type string parent description Required. The parent, which owns this collection of SearchHypernyms. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+$ required True type string path v1alpha1/{+parent}/searchHypernyms response $ref ListSearchHypernymsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates a SearchHypernym inside a corpus. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/corpora/{corporaId}/searchHypernyms/{searchHypernymsId} httpMethod PATCH id visionai.projects.locations.corpora.searchHypernyms.patch parameterOrder name parameters name description Resource name of the SearchHypernym. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}` location path pattern ^projects/[^/]+/locations/[^/]+/corpora/[^/]+/searchHypernyms/[^/]+$ required True type string updateMask description The list of fields to be updated. If left unset, all field paths will be updated/overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref SearchHypernym response $ref SearchHypernym scopes https://www.googleapis.com/auth/cloud-platform indexEndpoints methods create description Creates an IndexEndpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/indexEndpoints httpMethod POST id visionai.projects.locations.indexEndpoints.create parameterOrder parent parameters indexEndpointId description Optional. The ID to use for the IndexEndpoint, which will become the final component of the IndexEndpoint's resource name if the user specifies it. Otherwise, IndexEndpoint id will be autogenerated. This value should be up to 63 characters, and valid characters are a-z, 0-9 and dash (-). The first character must be a letter, the last must be a letter or a number. location query type string parent description Required. Format: `projects/{project}/locations/{location}` location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/indexEndpoints request $ref IndexEndpoint response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes an IndexEndpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId} httpMethod DELETE id visionai.projects.locations.indexEndpoints.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform deployIndex description Deploys an Index to IndexEndpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex httpMethod POST id visionai.projects.locations.indexEndpoints.deployIndex parameterOrder indexEndpoint parameters indexEndpoint description Required. IndexEndpoint the index is deployed to. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` location path pattern ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$ required True type string path v1alpha1/{+indexEndpoint}:deployIndex request $ref DeployIndexRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets an IndexEndpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId} httpMethod GET id visionai.projects.locations.indexEndpoints.get parameterOrder name parameters name description Required. Name of the IndexEndpoint resource. location path pattern ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$ required True type string path v1alpha1/{+name} response $ref IndexEndpoint scopes https://www.googleapis.com/auth/cloud-platform list description Lists all IndexEndpoints in a project. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/indexEndpoints httpMethod GET id visionai.projects.locations.indexEndpoints.list parameterOrder parent parameters filter description Optional. The filter applied to the returned list. We only support filtering for the `deployed_image_index.image_index` field. However, to filter by a corpus instead of an image index, simply use `deployed_image_index.corpus`, which will return all endpoints with `deployed_image_index.image_index` inside of the given corpus. A basic filter on image index would look like: deployed_image_index.image_index = "projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index" A basic filter on corpus would look like: deployed_image_index.corpus = "projects/123/locations/us-central1/corpora/my_corpus" location query type string pageSize description Optional. Requested page size. Server may return fewer items than requested. The service may return fewer than this value. If unspecified, a page size of 50 will be used. The maximum value is 1000; values above 1000 will be coerced to 1000. format int32 location query type integer pageToken description Optional. A token identifying a page of results the server should return. location query type string parent description Required. Format: `projects/{project}/locations/{location}` location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/indexEndpoints response $ref ListIndexEndpointsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates an IndexEndpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId} httpMethod PATCH id visionai.projects.locations.indexEndpoints.patch parameterOrder name parameters name description Output only. Resource name of the IndexEndpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_id}` location path pattern ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$ required True type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the IndexEndpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field of the resource will be overwritten if it is in the mask. Empty field mask is not allowed. If the mask is "*", then this is a full replacement of the resource. format google-fieldmask location query type string path v1alpha1/{+name} request $ref IndexEndpoint response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform searchIndexEndpoint description Search a deployed index endpoint (IMAGE corpus type only). flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:searchIndexEndpoint httpMethod POST id visionai.projects.locations.indexEndpoints.searchIndexEndpoint parameterOrder indexEndpoint parameters indexEndpoint description Required. The index endpoint to search. Format: `projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}' location path pattern ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$ required True type string path v1alpha1/{+indexEndpoint}:searchIndexEndpoint request $ref SearchIndexEndpointRequest response $ref SearchIndexEndpointResponse scopes https://www.googleapis.com/auth/cloud-platform undeployIndex description Undeploys an Index from IndexEndpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex httpMethod POST id visionai.projects.locations.indexEndpoints.undeployIndex parameterOrder indexEndpoint parameters indexEndpoint description Required. Resource name of the IndexEndpoint resource on which the undeployment will act. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}` location path pattern ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$ required True type string path v1alpha1/{+indexEndpoint}:undeployIndex request $ref UndeployIndexRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform resources operations methods get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId} httpMethod GET id visionai.projects.locations.indexEndpoints.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform operations methods cancel description Starts 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`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel httpMethod POST id visionai.projects.locations.operations.cancel parameterOrder name parameters name description The name of the operation resource to be cancelled. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name}:cancel request $ref CancelOperationRequest response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes 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`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod DELETE id visionai.projects.locations.operations.delete parameterOrder name parameters name description The name of the operation resource to be deleted. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id visionai.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations httpMethod GET id visionai.projects.locations.operations.list parameterOrder name parameters filter description The standard list filter. location query type string name description The name of the operation's parent resource. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string pageSize description The standard list page size. format int32 location query type integer pageToken description The standard list page token. location query type string path v1alpha1/{+name}/operations response $ref ListOperationsResponse scopes https://www.googleapis.com/auth/cloud-platform operators methods create description Creates a new Operator in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operators httpMethod POST id visionai.projects.locations.operators.create parameterOrder parent parameters operatorId description Required. Id of the requesting object. location query type string parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+parent}/operators request $ref Operator response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Operator. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operators/{operatorsId} httpMethod DELETE id visionai.projects.locations.operators.delete parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/operators/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Operator. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operators/{operatorsId} httpMethod GET id visionai.projects.locations.operators.get parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/operators/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operator scopes https://www.googleapis.com/auth/cloud-platform getIamPolicy description Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operators/{operatorsId}:getIamPolicy httpMethod GET id visionai.projects.locations.operators.getIamPolicy parameterOrder resource parameters options.requestedPolicyVersion description Optional. 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). format int32 location query type integer resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/operators/[^/]+$ required True type string path v1alpha1/{+resource}:getIamPolicy response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform list description Lists Operators in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operators httpMethod GET id visionai.projects.locations.operators.list parameterOrder parent parameters filter description Filtering results. location query type string orderBy description Hint for how to order the results. location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListOperatorsRequest. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/operators response $ref ListOperatorsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Operator. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operators/{operatorsId} httpMethod PATCH id visionai.projects.locations.operators.patch parameterOrder name parameters name description Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/operators/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Required. Field mask is used to specify the fields to be overwritten in the Operator resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Operator response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform setIamPolicy description Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operators/{operatorsId}:setIamPolicy httpMethod POST id visionai.projects.locations.operators.setIamPolicy parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/operators/[^/]+$ required True type string path v1alpha1/{+resource}:setIamPolicy request $ref SetIamPolicyRequest response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform testIamPermissions description Returns 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operators/{operatorsId}:testIamPermissions httpMethod POST id visionai.projects.locations.operators.testIamPermissions parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/operators/[^/]+$ required True type string path v1alpha1/{+resource}:testIamPermissions request $ref TestIamPermissionsRequest response $ref TestIamPermissionsResponse scopes https://www.googleapis.com/auth/cloud-platform resources versions methods getIamPolicy description Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operators/{operatorsId}/versions/{versionsId}:getIamPolicy httpMethod GET id visionai.projects.locations.operators.versions.getIamPolicy parameterOrder resource parameters options.requestedPolicyVersion description Optional. 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). format int32 location query type integer resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/operators/[^/]+/versions/[^/]+$ required True type string path v1alpha1/{+resource}:getIamPolicy response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform setIamPolicy description Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operators/{operatorsId}/versions/{versionsId}:setIamPolicy httpMethod POST id visionai.projects.locations.operators.versions.setIamPolicy parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/operators/[^/]+/versions/[^/]+$ required True type string path v1alpha1/{+resource}:setIamPolicy request $ref SetIamPolicyRequest response $ref Policy scopes https://www.googleapis.com/auth/cloud-platform testIamPermissions description Returns 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operators/{operatorsId}/versions/{versionsId}:testIamPermissions httpMethod POST id visionai.projects.locations.operators.versions.testIamPermissions parameterOrder resource parameters resource description REQUIRED: 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. location path pattern ^projects/[^/]+/locations/[^/]+/operators/[^/]+/versions/[^/]+$ required True type string path v1alpha1/{+resource}:testIamPermissions request $ref TestIamPermissionsRequest response $ref TestIamPermissionsResponse scopes https://www.googleapis.com/auth/cloud-platform processors methods create description Creates a new Processor in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/processors httpMethod POST id visionai.projects.locations.processors.create parameterOrder parent parameters parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string processorId description Required. Id of the requesting object. location query type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+parent}/processors request $ref Processor response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single Processor. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId} httpMethod DELETE id visionai.projects.locations.processors.delete parameterOrder name parameters name description Required. Name of the resource location path pattern ^projects/[^/]+/locations/[^/]+/processors/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single Processor. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId} httpMethod GET id visionai.projects.locations.processors.get parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/processors/[^/]+$ required True type string path v1alpha1/{+name} response $ref Processor scopes https://www.googleapis.com/auth/cloud-platform list description Lists Processors in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/processors httpMethod GET id visionai.projects.locations.processors.list parameterOrder parent parameters filter description Filtering results. location query type string orderBy description Hint for how to order the results. location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListProcessorsRequest. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/processors response $ref ListProcessorsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates the parameters of a single Processor. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/processors/{processorsId} httpMethod PATCH id visionai.projects.locations.processors.patch parameterOrder name parameters name description name of resource. location path pattern ^projects/[^/]+/locations/[^/]+/processors/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string updateMask description Optional. Field mask is used to specify the fields to be overwritten in the Processor resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref Processor response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform prebuilt description ListPrebuiltProcessors is a custom pass-through verb that Lists Prebuilt Processors. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/processors:prebuilt httpMethod POST id visionai.projects.locations.processors.prebuilt parameterOrder parent parameters parent description Required. Parent path. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/processors:prebuilt request $ref ListPrebuiltProcessorsRequest response $ref ListPrebuiltProcessorsResponse scopes https://www.googleapis.com/auth/cloud-platform retailCatalogs methods create description Creates a new RetailCatalog in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs httpMethod POST id visionai.projects.locations.retailCatalogs.create parameterOrder parent parameters parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string retailCatalogId description Required. Id of the requesting object. location query type string path v1alpha1/{+parent}/retailCatalogs request $ref RetailCatalog response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single RetailCatalog. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId} httpMethod DELETE id visionai.projects.locations.retailCatalogs.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single RetailCatalog. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId} httpMethod GET id visionai.projects.locations.retailCatalogs.get parameterOrder name parameters name description Required. Name of the RetailCatalog resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+$ required True type string path v1alpha1/{+name} response $ref RetailCatalog scopes https://www.googleapis.com/auth/cloud-platform importRetailProducts description Imports RetailProducts into a RetailCatalog. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}:importRetailProducts httpMethod POST id visionai.projects.locations.retailCatalogs.importRetailProducts parameterOrder name parameters name description Required. RetailCatalog resource name. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+$ required True type string path v1alpha1/{+name}:importRetailProducts request $ref ImportRetailProductsRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists RetailCatalogs in a Location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs httpMethod GET id visionai.projects.locations.retailCatalogs.list parameterOrder parent parameters filter description Optional. An expression for filtering the results of the request. location query type string orderBy description Optional. A comma-separated list of fields to order by sorted in ascending order. Use "desc" after a field name for descending. location query type string pageSize description Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description Optional. A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListRetailCatalogsRequest. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/retailCatalogs response $ref ListRetailCatalogsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates details of a single RetailCatalog. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId} httpMethod PATCH id visionai.projects.locations.retailCatalogs.patch parameterOrder name parameters name description Output only. Name of the RetailCatalog resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+$ required True type string updateMask description Optional. Field mask is used to specify the fields to be overwritten in the RetailCatalog resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref RetailCatalog response $ref RetailCatalog scopes https://www.googleapis.com/auth/cloud-platform resources retailProductRecognitionIndexes methods create description Creates a new RetailProductRecognitionIndex. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductRecognitionIndexes httpMethod POST id visionai.projects.locations.retailCatalogs.retailProductRecognitionIndexes.create parameterOrder parent parameters coverageOutput.outputUriPrefix description Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. location query type string parent description Required. Value for parent. The resource name of the RetailCatalog to create this RetailProductRecognitionIndex in. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string retailProductRecognitionIndexId description Required. Id of the requesting object. location query type string path v1alpha1/{+parent}/retailProductRecognitionIndexes request $ref RetailProductRecognitionIndex response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single RetailProductRecognitionIndex. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductRecognitionIndexes/{retailProductRecognitionIndexesId} httpMethod DELETE id visionai.projects.locations.retailCatalogs.retailProductRecognitionIndexes.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProductRecognitionIndexes/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform exportCoverage description Exports the product images coverage of a single RetailProductRecognitionIndex. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductRecognitionIndexes/{retailProductRecognitionIndexesId}:exportCoverage httpMethod POST id visionai.projects.locations.retailCatalogs.retailProductRecognitionIndexes.exportCoverage parameterOrder name parameters name description Required. Name of the RetailProductRecognitionIndex resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProductRecognitionIndexes/[^/]+$ required True type string path v1alpha1/{+name}:exportCoverage request $ref ExportRetailProductRecognitionIndexCoverageRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single RetailProductRecognitionIndex. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductRecognitionIndexes/{retailProductRecognitionIndexesId} httpMethod GET id visionai.projects.locations.retailCatalogs.retailProductRecognitionIndexes.get parameterOrder name parameters name description Required. Name of the RetailProductRecognitionIndex resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProductRecognitionIndexes/[^/]+$ required True type string path v1alpha1/{+name} response $ref RetailProductRecognitionIndex scopes https://www.googleapis.com/auth/cloud-platform list description Lists RetailProductRecognitionIndexes in a given Catalog. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductRecognitionIndexes httpMethod GET id visionai.projects.locations.retailCatalogs.retailProductRecognitionIndexes.list parameterOrder parent parameters filter description Optional. An expression for filtering the results of the request. location query type string orderBy description Optional. A comma-separated list of fields to order by sorted in ascending order. Use "desc" after a field name for descending. location query type string pageSize description Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description Optional. A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListRetailProductRecognitionIndexesRequest. The resource name of the RetailCatalog to list from. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+$ required True type string path v1alpha1/{+parent}/retailProductRecognitionIndexes response $ref ListRetailProductRecognitionIndexesResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates details of a single RetailProductRecognitionIndex. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductRecognitionIndexes/{retailProductRecognitionIndexesId} httpMethod PATCH id visionai.projects.locations.retailCatalogs.retailProductRecognitionIndexes.patch parameterOrder name parameters name description Output only. Resource name of the RetailProductRecognitionIndex resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProductRecognitionIndexes/[^/]+$ required True type string updateMask description Optional. Field mask is used to specify the fields to be overwritten in the RetailCatalog resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. Only display_name and description can be updated in a ProductRecoginitionIndex. format google-fieldmask location query type string path v1alpha1/{+name} request $ref RetailProductRecognitionIndex response $ref RetailProductRecognitionIndex scopes https://www.googleapis.com/auth/cloud-platform retailProductSets methods add description Adds RetailProducts into RetailProductSet. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductSets/{retailProductSetsId}:add httpMethod POST id visionai.projects.locations.retailCatalogs.retailProductSets.add parameterOrder name parameters name description Required. RetailProductSet resource name. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProductSets/[^/]+$ required True type string path v1alpha1/{+name}:add request $ref AddRetailProductsToRetailProductSetRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform create description Creates a new RetailProductSet. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductSets httpMethod POST id visionai.projects.locations.retailCatalogs.retailProductSets.create parameterOrder parent parameters parent description Required. Parent of the RetailProductSet resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+$ required True type string retailProductSetId description Required. Id of the requesting object. location query type string path v1alpha1/{+parent}/retailProductSets request $ref RetailProductSet response $ref RetailProductSet scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single RetailProductSet. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductSets/{retailProductSetsId} httpMethod DELETE id visionai.projects.locations.retailCatalogs.retailProductSets.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProductSets/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single RetailProductSet. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductSets/{retailProductSetsId} httpMethod GET id visionai.projects.locations.retailCatalogs.retailProductSets.get parameterOrder name parameters name description Required. Name of the RetailProductSet resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProductSets/[^/]+$ required True type string path v1alpha1/{+name} response $ref RetailProductSet scopes https://www.googleapis.com/auth/cloud-platform list description Lists RetailProductSets of a single Product. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductSets httpMethod GET id visionai.projects.locations.retailCatalogs.retailProductSets.list parameterOrder parent parameters filter description Optional. An expression for filtering the results of the request. location query type string orderBy description Optional. A comma-separated list of fields to order by sorted in ascending order. Use "desc" after a field name for descending. location query type string pageSize description Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description Optional. A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListRetailProductSetsRequest. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+$ required True type string path v1alpha1/{+parent}/retailProductSets response $ref ListRetailProductSetsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates details of a single RetailProductSet. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductSets/{retailProductSetsId} httpMethod PATCH id visionai.projects.locations.retailCatalogs.retailProductSets.patch parameterOrder name parameters name description Output only. Resource name of the RetailProductSet. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProductSets/[^/]+$ required True type string updateMask description Optional. Field mask is used to specify the fields to be overwritten in the RetailProductSet resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref RetailProductSet response $ref RetailProductSet scopes https://www.googleapis.com/auth/cloud-platform remove description Removes RetailProducts from RetailProductSet. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProductSets/{retailProductSetsId}:remove httpMethod POST id visionai.projects.locations.retailCatalogs.retailProductSets.remove parameterOrder name parameters name description Required. RetailProductSet resource name. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProductSets/[^/]+$ required True type string path v1alpha1/{+name}:remove request $ref RemoveRetailProductsFromRetailProductSetRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform retailProducts methods create description Creates a new RetailProduct in a given Catalog. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProducts httpMethod POST id visionai.projects.locations.retailCatalogs.retailProducts.create parameterOrder parent parameters parent description Required. Parent of the RetailProduct resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+$ required True type string retailProductId description Required. Id of the requesting object. location query type string path v1alpha1/{+parent}/retailProducts request $ref RetailProduct response $ref RetailProduct scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single RetailProduct. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProducts/{retailProductsId} httpMethod DELETE id visionai.projects.locations.retailCatalogs.retailProducts.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProducts/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single RetailProduct. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProducts/{retailProductsId} httpMethod GET id visionai.projects.locations.retailCatalogs.retailProducts.get parameterOrder name parameters name description Required. Name of the RetailProduct resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProducts/[^/]+$ required True type string path v1alpha1/{+name} response $ref RetailProduct scopes https://www.googleapis.com/auth/cloud-platform list description Lists RetailProducts in a given Catalog. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProducts httpMethod GET id visionai.projects.locations.retailCatalogs.retailProducts.list parameterOrder parent parameters filter description Optional. An expression for filtering the results of the request. location query type string orderBy description Optional. A comma-separated list of fields to order by sorted in ascending order. Use "desc" after a field name for descending. location query type string pageSize description Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description Optional. A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListRetailProductsRequest. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+$ required True type string path v1alpha1/{+parent}/retailProducts response $ref ListRetailProductsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates details of a single RetailProduct. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProducts/{retailProductsId} httpMethod PATCH id visionai.projects.locations.retailCatalogs.retailProducts.patch parameterOrder name parameters name description Output only. Name of the RetailProduct resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProducts/[^/]+$ required True type string updateMask description Optional. Field mask is used to specify the fields to be overwritten in the RetailProduct resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref RetailProduct response $ref RetailProduct scopes https://www.googleapis.com/auth/cloud-platform resources retailProductImages methods create description Creates a new RetailProductImage. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProducts/{retailProductsId}/retailProductImages httpMethod POST id visionai.projects.locations.retailCatalogs.retailProducts.retailProductImages.create parameterOrder parent parameters parent description Required. Parent of the RetailProductImage resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProducts/[^/]+$ required True type string retailProductImageId description Required. Id of the requesting object. location query type string path v1alpha1/{+parent}/retailProductImages request $ref RetailProductImage response $ref RetailProductImage scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single RetailProductImage. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProducts/{retailProductsId}/retailProductImages/{retailProductImagesId} httpMethod DELETE id visionai.projects.locations.retailCatalogs.retailProducts.retailProductImages.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProducts/[^/]+/retailProductImages/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single RetailProductImage. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProducts/{retailProductsId}/retailProductImages/{retailProductImagesId} httpMethod GET id visionai.projects.locations.retailCatalogs.retailProducts.retailProductImages.get parameterOrder name parameters name description Required. Name of the RetailProductImage resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProducts/[^/]+/retailProductImages/[^/]+$ required True type string path v1alpha1/{+name} response $ref RetailProductImage scopes https://www.googleapis.com/auth/cloud-platform list description Lists RetailProductImages of a single Product. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProducts/{retailProductsId}/retailProductImages httpMethod GET id visionai.projects.locations.retailCatalogs.retailProducts.retailProductImages.list parameterOrder parent parameters filter description Optional. An expression for filtering the results of the request. location query type string orderBy description Optional. A comma-separated list of fields to order by sorted in ascending order. Use "desc" after a field name for descending. location query type string pageSize description Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description Optional. A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListRetailProductImagesRequest. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProducts/[^/]+$ required True type string path v1alpha1/{+parent}/retailProductImages response $ref ListRetailProductImagesResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates details of a single RetailProductImage. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailCatalogs/{retailCatalogsId}/retailProducts/{retailProductsId}/retailProductImages/{retailProductImagesId} httpMethod PATCH id visionai.projects.locations.retailCatalogs.retailProducts.retailProductImages.patch parameterOrder name parameters name description Output only. Resource name of the RetailProductImage. location path pattern ^projects/[^/]+/locations/[^/]+/retailCatalogs/[^/]+/retailProducts/[^/]+/retailProductImages/[^/]+$ required True type string updateMask description Optional. Field mask is used to specify the fields to be overwritten in the RetailProductImage resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask location query type string path v1alpha1/{+name} request $ref RetailProductImage response $ref RetailProductImage scopes https://www.googleapis.com/auth/cloud-platform retailEndpoints methods batchAnalyze description Performs batch ML inference on input data. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailEndpoints/{retailEndpointsId}:batchAnalyze httpMethod POST id visionai.projects.locations.retailEndpoints.batchAnalyze parameterOrder retailEndpoint parameters retailEndpoint description Required. Resource name of the RetailEndpoint to serve the inference request. location path pattern ^projects/[^/]+/locations/[^/]+/retailEndpoints/[^/]+$ required True type string path v1alpha1/{+retailEndpoint}:batchAnalyze request $ref RetailBatchAnalyzeRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform create description Creates a new RetailEndpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailEndpoints httpMethod POST id visionai.projects.locations.retailEndpoints.create parameterOrder parent parameters parent description Required. Value for parent. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string retailEndpointId description Required. Id of the requesting object. location query type string path v1alpha1/{+parent}/retailEndpoints request $ref RetailEndpoint response $ref RetailEndpoint scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single RetailEndpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailEndpoints/{retailEndpointsId} httpMethod DELETE id visionai.projects.locations.retailEndpoints.delete parameterOrder name parameters name description Required. Name of the resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailEndpoints/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform deployRetailProductRecognitionIndex description Deploys a ProductRecognitionIndex into a RetailEndpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailEndpoints/{retailEndpointsId}:deployRetailProductRecognitionIndex httpMethod POST id visionai.projects.locations.retailEndpoints.deployRetailProductRecognitionIndex parameterOrder retailEndpoint parameters retailEndpoint description Required. Resource name of the RetailEndpoint resource into where the RetailProductRecognitionIndex is deployed. location path pattern ^projects/[^/]+/locations/[^/]+/retailEndpoints/[^/]+$ required True type string path v1alpha1/{+retailEndpoint}:deployRetailProductRecognitionIndex request $ref DeployRetailProductRecognitionIndexRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single RetailEndpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailEndpoints/{retailEndpointsId} httpMethod GET id visionai.projects.locations.retailEndpoints.get parameterOrder name parameters name description Required. Name of the RetailEndpoint resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailEndpoints/[^/]+$ required True type string path v1alpha1/{+name} response $ref RetailEndpoint scopes https://www.googleapis.com/auth/cloud-platform list description Lists RetailEndpoints in a given project. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailEndpoints httpMethod GET id visionai.projects.locations.retailEndpoints.list parameterOrder parent parameters filter description Optional. An expression for filtering the results of the request. location query type string orderBy description Optional. A comma-separated list of fields to order by sorted in ascending order. Use "desc" after a field name for descending. location query type string pageSize description Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description Optional. A token identifying a page of results the server should return. location query type string parent description Required. Parent value for ListRetailEndpointsRequest. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/retailEndpoints response $ref ListRetailEndpointsResponse scopes https://www.googleapis.com/auth/cloud-platform patch description Updates details of a single RetailEndpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailEndpoints/{retailEndpointsId} httpMethod PATCH id visionai.projects.locations.retailEndpoints.patch parameterOrder name parameters name description Output only. Resource name of the RetailEndpoint resource. location path pattern ^projects/[^/]+/locations/[^/]+/retailEndpoints/[^/]+$ required True type string updateMask description Optional. Field mask is used to specify the fields to be overwritten in the RetailCatalog resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. Display_name, description, customized_price_tag_parsing_model and customized_product_detection_model can be updated with this api. To update deployed_product_recogion_index, use Deploy/UndeployProductRecoginitionIndex api instead. format google-fieldmask location query type string path v1alpha1/{+name} request $ref RetailEndpoint response $ref RetailEndpoint scopes https://www.googleapis.com/auth/cloud-platform undeployRetailProductRecognitionIndex description Undeploys a RetailProductRecognitionIndex from a RetailEndpoint. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/retailEndpoints/{retailEndpointsId}:undeployRetailProductRecognitionIndex httpMethod POST id visionai.projects.locations.retailEndpoints.undeployRetailProductRecognitionIndex parameterOrder retailEndpoint parameters retailEndpoint description Required. Resource name of the RetailEndpoint resource on which the undeployment will act. location path pattern ^projects/[^/]+/locations/[^/]+/retailEndpoints/[^/]+$ required True type string path v1alpha1/{+retailEndpoint}:undeployRetailProductRecognitionIndex request $ref UndeployRetailProductRecognitionIndexRequest response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform warehouseOperations methods get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/warehouseOperations/{warehouseOperationsId} httpMethod GET id visionai.projects.locations.warehouseOperations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/warehouseOperations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform revision 20231209 rootUrl https://visionai.googleapis.com/ schemas AIEnabledDevicesInputConfig description Message describing AI-enabled Devices Input Config. id AIEnabledDevicesInputConfig properties type object AcquireLeaseRequest description Request message for acquiring a lease. id AcquireLeaseRequest properties leaseType description The lease type. enum LEASE_TYPE_UNSPECIFIED LEASE_TYPE_READER LEASE_TYPE_WRITER enumDescriptions Lease type unspecified. Lease for stream reader. Lease for stream writer. type string owner description The owner name. type string term description The lease term. format google-duration type string type object AddApplicationStreamInputRequest description Message for adding stream input to an Application. id AddApplicationStreamInputRequest properties applicationStreamInputs description The stream inputs to add, the stream resource name is the key of each StreamInput, and it must be unique within each application. items $ref ApplicationStreamInput type array requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). type string type object AddApplicationStreamInputResponse description Message for AddApplicationStreamInput Response. id AddApplicationStreamInputResponse properties type object AddCollectionItemRequest description Request message for AddCollectionItem. id AddCollectionItemRequest properties item $ref CollectionItem description Required. The item to be added. type object AddCollectionItemResponse description Response message for AddCollectionItem. id AddCollectionItemResponse properties item $ref CollectionItem description The item that has already been added. type object AddRetailProductsToRetailProductSetRequest description Message for adding RetailProducts into RetailProductSet. id AddRetailProductsToRetailProductSetRequest properties gcsSource $ref GcsSource description Optional. The Google Cloud Storage location for the input content. Support single TXT file where each line is the product id to be imported. productFilter description A standard filter that will be applied to all RetailProducts in the parent RetailCatalog, select items which satify filter condition and add them into the RetailProductSet. Cannot be used together with product_ids. Supported filters: https://google.aip.dev/160 type string productIds description Resource id of the RetailProducts to be added. They must all belong to the same RetailCatalog as the specified desitination RetailProductSet. Up to 200 RetailProducts ids can be specified in one request. Can not be used together with product_filter. items type string type array type object AddRetailProductsToRetailProductSetResponse description AddRetailProductsToRetailProductSet response once the operation is done. id AddRetailProductsToRetailProductSetResponse properties type object Analysis description Message describing the Analysis object. id Analysis properties analysisDefinition $ref AnalysisDefinition description The definition of the analysis. createTime description Output only. The create timestamp. format google-datetime readOnly True type string disableEventWatch description Boolean flag to indicate whether you would like to disable the ability to automatically start a Process when new event happening in the input Stream. If you would like to start a Process manually, the field needs to be set to true. type boolean inputStreamsMapping additionalProperties type string description Map from the input parameter in the definition to the real stream. E.g., suppose you had a stream source operator named "input-0" and you try to receive from the real stream "stream-0". You can add the following mapping: [input-0: stream-0]. type object labels additionalProperties type string description Labels as key value pairs. type object name description The name of resource. type string outputStreamsMapping additionalProperties type string description Map from the output parameter in the definition to the real stream. E.g., suppose you had a stream sink operator named "output-0" and you try to send to the real stream "stream-0". You can add the following mapping: [output-0: stream-0]. type object updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object AnalysisDefinition description Defines a full analysis. This is a description of the overall live analytics pipeline. You may think of this as an edge list representation of a multigraph. This may be directly authored by a human in protobuf textformat, or it may be generated by a programming API (perhaps Python or JavaScript depending on context). id AnalysisDefinition properties analyzers description Analyzer definitions. items $ref AnalyzerDefinition type array type object AnalysisStatus description The status of analysis on each search capability. id AnalysisStatus properties searchCapability $ref SearchCapability description The search capability requested. state enum STATE_UNSPECIFIED IN_PROGRESS SUCCEEDED FAILED enumDescriptions The default process state should never happen. The feature is in progress. The process is successfully done. The process failed. type string statusMessage type string type object AnalyzeAssetMetadata description Metadata for AnalyzeAsset. id AnalyzeAssetMetadata properties analysisStatus description The status of analysis on all search capabilities. items $ref AnalysisStatus type array startTime description The start time of the operation. format google-datetime type string updateTime description The update time of the operation. format google-datetime type string type object AnalyzeAssetRequest description Request message for AnalyzeAsset. id AnalyzeAssetRequest properties type object AnalyzeAssetResponse description Response message for AnalyzeAsset. id AnalyzeAssetResponse properties type object AnalyzeCorpusMetadata description The metadata message for AnalyzeCorpus LRO. id AnalyzeCorpusMetadata properties metadata $ref OperationMetadata description The metadata of the operation. type object AnalyzeCorpusRequest description Request message for AnalyzeCorpus. id AnalyzeCorpusRequest properties type object AnalyzeCorpusResponse description The response message for AnalyzeCorpus LRO. id AnalyzeCorpusResponse properties type object AnalyzerDefinition description Defines an Analyzer. An analyzer processes data from its input streams using the logic defined in the Operator that it represents. Of course, it produces data for the output streams declared in the Operator. id AnalyzerDefinition properties analyzer description The name of this analyzer. Tentatively a-z*(_[a-z0-9]+)*. type string attrs additionalProperties $ref AttributeValue description The attribute values that this analyzer applies to the operator. Supply a mapping between the attribute names and the actual value you wish to apply. If an attribute name is omitted, then it will take a preconfigured default value. type object debugOptions $ref DebugOptions description Debug options. inputs description Input streams. items $ref StreamInput type array operator description The name of the operator that this analyzer runs. Must match the name of a supported operator. type string operatorOption $ref OperatorOption description Operator option. type object Annotation description An annotation is a resource in asset. It represents a key-value mapping of content in asset. id Annotation properties name description Resource name of the annotation. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}/annotations/{annotation}` type string userSpecifiedAnnotation $ref UserSpecifiedAnnotation description User provided annotation. type object AnnotationCustomizedStruct description Customized struct represnation in annotation. id AnnotationCustomizedStruct properties elements additionalProperties $ref AnnotationValue description A map from elements' keys to element's annotation value. type object type object AnnotationList description List representation in annotation. id AnnotationList properties values description The values of `LIST` data type annotation. items $ref AnnotationValue type array type object AnnotationMatchingResult description Stores the criteria-annotation matching results for each search result item. id AnnotationMatchingResult properties criteria $ref Criteria description The criteria used for matching. It can be an input search criteria or a criteria converted from a facet selection. matchedAnnotations description Matched annotations for the criteria. items $ref Annotation type array status $ref Status description Status of the match result. Possible values: FAILED_PRECONDITION - the criteria is not eligible for match. OK - matching is performed. type object AnnotationValue description Value of annotation, including all types available in data schema. id AnnotationValue properties boolValue description Value of boolean type annotation. type boolean customizedStructDataValue additionalProperties description Properties of the object. type any description Value of customized struct annotation. This field does not have effects. Use customized_struct_value instead for customized struct annotation. type object customizedStructValue $ref AnnotationCustomizedStruct description Value of custom struct type annotation. datetimeValue description Value of date time type annotation. type string floatValue description Value of float type annotation. format float type number geoCoordinate $ref GeoCoordinate description Value of geo coordinate type annotation. intValue description Value of int type annotation. format int64 type string listValue $ref AnnotationList description Value of list type annotation. protoAnyValue additionalProperties description Properties of the object. Contains field @type with type URL. type any description Value of any proto value. type object strValue description Value of string type annotation. type string type object AppPlatformCloudFunctionRequest description For any cloud function based customer processing logic, customer's cloud function is expected to receive AppPlatformCloudFunctionRequest as request and send back AppPlatformCloudFunctionResponse as response. Message of request from AppPlatform to Cloud Function. id AppPlatformCloudFunctionRequest properties annotations description The actual annotations to be processed by the customized Cloud Function. items $ref StructedInputAnnotation type array appPlatformMetadata $ref AppPlatformMetadata description The metadata of the AppPlatform for customer to identify the source of the payload. type object AppPlatformCloudFunctionResponse description Message of the response from customer's Cloud Function to AppPlatform. id AppPlatformCloudFunctionResponse properties annotationPassthrough description If set to true, AppPlatform will use original annotations instead of dropping them, even if it is empty in the annotations filed. type boolean annotations description The modified annotations that is returned back to AppPlatform. If the annotations fields are empty, then those annotations will be dropped by AppPlatform. items $ref StructedOutputAnnotation type array events description The event notifications that is returned back to AppPlatform. Typically it will then be configured to be consumed/forwared to a operator that handles events, such as Pub/Sub operator. items $ref AppPlatformEventBody type array type object AppPlatformEventBody description Message of content of appPlatform event id AppPlatformEventBody properties eventId description User defined Event Id, used to classify event, within a delivery interval, events from the same application instance with the same id will be de-duplicated & only first one will be sent out. Empty event_id will be treated as "". type string eventMessage description Human readable string of the event like "There are more than 6 people in the scene". or "Shelf is empty!". type string payload additionalProperties description Properties of the object. type any description For the case of Pub/Sub, it will be stored in the message attributes. ​​pubsub.proto type object type object AppPlatformMetadata description Message of essential metadata of App Platform. This message is usually attached to a certain processor output annotation for customer to identify the source of the data. id AppPlatformMetadata properties application description The application resource name. type string instanceId description The instance resource id. Instance is the nested resource of application under collection 'instances'. type string node description The node name of the application graph. type string processor description The referred processor resource name of the application node. type string type object Application description Message describing Application object id Application properties applicationConfigs $ref ApplicationConfigs description Application graph configuration. billingMode description Billing mode of the application. enum BILLING_MODE_UNSPECIFIED PAYG MONTHLY enumDescriptions The default value. Pay as you go billing mode. Monthly billing mode. type string createTime description Output only. [Output only] Create timestamp format google-datetime readOnly True type string description description A description for this application. type string displayName description Required. A user friendly display name for the solution. type string labels additionalProperties type string description Labels as key value pairs type object name description name of resource type string runtimeInfo $ref ApplicationRuntimeInfo description Output only. Application graph runtime info. Only exists when application state equals to DEPLOYED. readOnly True state description Output only. State of the application. enum STATE_UNSPECIFIED CREATED DEPLOYING DEPLOYED UNDEPLOYING DELETED ERROR CREATING UPDATING DELETING FIXING enumDescriptions The default value. This value is used if the state is omitted. State CREATED. State DEPLOYING. State DEPLOYED. State UNDEPLOYING. State DELETED. State ERROR. State CREATING. State Updating. State Deleting. State Fixing. readOnly True type string updateTime description Output only. [Output only] Update timestamp format google-datetime readOnly True type string type object ApplicationConfigs description Message storing the graph of the application. id ApplicationConfigs properties nodes description A list of nodes in the application graph. items $ref Node type array type object ApplicationInstance description Message for creating a Instance. id ApplicationInstance properties instance $ref Instance description Required. The resource being created. instanceId description Required. Id of the requesting object. type string type object ApplicationNodeAnnotation description Message describing annotations specific to application node. This message is a duplication of StreamWithAnnotation.NodeAnnotation. id ApplicationNodeAnnotation properties annotations description The node specific stream annotations. items $ref StreamAnnotation type array node description The node name of the application graph. type string type object ApplicationRuntimeInfo description Message storing the runtime information of the application. id ApplicationRuntimeInfo properties deployTime description Timestamp when the engine be deployed format google-datetime type string globalOutputResources description Globally created resources like warehouse dataschemas. items $ref GlobalOutputResource type array monitoringConfig $ref MonitoringConfig description Monitoring-related configuration for this application. type object ApplicationStreamInput description Message about a single stream input config. id ApplicationStreamInput properties streamWithAnnotation $ref StreamWithAnnotation type object ArgumentDefinition description Defines an argument to an operator. Used for both inputs and outputs. id ArgumentDefinition properties argument description The name of the argument. Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., video, audio, high_fps_frame. type string type description The data type of the argument. This should match the textual representation of a stream/Packet type. type string type object Asset description An asset is a resource in corpus. It represents a media object inside corpus, contains metadata and another resource annotation. Different feature could be applied to the asset to generate annotations. User could specified annotation related to the target asset. id Asset properties assetGcsSource $ref AssetGcsSource description Output only. The original cloud storage source uri that is associated with this asset. readOnly True name description Resource name of the asset. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` type string ttl description The duration for which all media assets, associated metadata, and search documents can exist. If not set, then it will using the default ttl in the parent corpus resource. format google-duration type string type object AssetContentData description The content of the asset. id AssetContentData properties assetContentData format byte type string type object AssetGcsSource description The asset source is from Cloud Storage. id AssetGcsSource properties gcsUri description Cloud storage uri. type string type object AssetSource description The source of the asset. id AssetSource properties assetContentData $ref AssetContentData description The source of the asset is from content bytes. assetGcsSource $ref AssetGcsSource description The source of the asset is from Cloud Storage. type object AttributeDefinition description Defines an attribute of an operator. id AttributeDefinition properties attribute description The name of the attribute. Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., max_frames_per_video, resize_height. type string defaultValue $ref AttributeValue description The default value for the attribute. type description The type of this attribute. See attribute_value.proto for possibilities. type string type object AttributeValue description Represents an actual value of an operator attribute. id AttributeValue properties b description bool. type boolean f description float. format float type number i description int. format int64 type string s description string. format byte type string type object AutoscalingMetricSpec description The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. id AutoscalingMetricSpec properties metricName description Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` type string target description The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. format int32 type integer type object BatchRunProcessOptions description Options for batch processes. id BatchRunProcessOptions properties batchSize description The batch size. Default: 5, maximum: 100. format int32 type integer retryCount description The retry counts per process. Default: 3. format int32 type integer type object BatchRunProcessRequest description Request message for running the processes in a batch. id BatchRunProcessRequest properties batchId description Output only. The batch ID. readOnly True type string options $ref BatchRunProcessOptions description Optional. Options for batch processes. requests description Required. The create process requests. items $ref CreateProcessRequest type array type object BatchRunProcessResponse description Response message for running the processes in a batch. id BatchRunProcessResponse properties batchId description The batch ID. type string processes description Processes created. items $ref Process type array type object BigQueryConfig description Message of configurations for BigQuery processor. id BigQueryConfig properties cloudFunctionMapping additionalProperties type string description Data Schema By default, Vision AI Application will try to write annotations to the target BigQuery table using the following schema: ingestion_time: TIMESTAMP, the ingestion time of the original data. application: STRING, name of the application which produces the annotation. instance: STRING, Id of the instance which produces the annotation. node: STRING, name of the application graph node which produces the annotation. annotation: STRING or JSON, the actual annotation protobuf will be converted to json string with bytes field as 64 encoded string. It can be written to both String or Json type column. To forward annotation data to an existing BigQuery table, customer needs to make sure the compatibility of the schema. The map maps application node name to its corresponding cloud function endpoint to transform the annotations directly to the google.cloud.bigquery.storage.v1.AppendRowsRequest (only avro_rows or proto_rows should be set). If configured, annotations produced by corresponding application node will sent to the Cloud Function at first before be forwarded to BigQuery. If the default table schema doesn't fit, customer is able to transform the annotation output from Vision AI Application to arbitrary BigQuery table schema with CloudFunction. * The cloud function will receive AppPlatformCloudFunctionRequest where the annotations field will be the json format of Vision AI annotation. * The cloud function should return AppPlatformCloudFunctionResponse with AppendRowsRequest stored in the annotations field. * To drop the annotation, simply clear the annotations field in the returned AppPlatformCloudFunctionResponse. type object createDefaultTableIfNotExists description If true, App Platform will create the BigQuery DataSet and the BigQuery Table with default schema if the specified table doesn't exist. This doesn't work if any cloud function customized schema is specified since the system doesn't know your desired schema. JSON column will be used in the default table created by App Platform. type boolean table description BigQuery table resource for Vision AI Platform to ingest annotations to. type string type object Binding description Associates `members`, or principals, with a `role`. id Binding properties condition $ref Expr description The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). members description Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `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. items type string type array role description Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. type string type object BoolValue id BoolValue properties value type boolean type object BoundingBox description Boundingbox for detected object. I.e. the rectangle over the video frame pinpointing the found AnnotationSpec. The coordinates are relative to the frame size, and the point 0,0 is in the top left of the frame. id BoundingBox properties xMax description The rightmost coordinate of the bounding box. format float type number xMin description The leftmost coordinate of the bounding box. format float type number yMax description The bottommost coordinate of the bounding box. format float type number yMin description The topmost coordinate of the bounding box. format float type number type object CancelOperationRequest description The request message for Operations.CancelOperation. id CancelOperationRequest properties type object Channel description Message describing the Channel object. id Channel properties annotations additionalProperties type string description Annotations to allow clients to store small amounts of arbitrary data. type object createTime description Output only. The create timestamp. format google-datetime readOnly True type string event description Required. Event that is associated with this series. type string labels additionalProperties type string description Labels as key value pairs. type object name description Name of the resource. type string stream description Required. Stream that is associated with this series. type string updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object CircleArea description Representation of a circle area. id CircleArea properties latitude description Latitude of circle area's center. Degrees [-90 .. 90] format double type number longitude description Longitude of circle area's center. Degrees [-180 .. 180] format double type number radiusMeter description Radius of the circle area in meters. format double type number type object ClassificationPredictionResult description Prediction output format for Image and Text Classification. id ClassificationPredictionResult properties confidences description The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids. items format float type number type array displayNames description The display names of the AnnotationSpecs that had been identified, order matches the IDs. items type string type array ids description The resource IDs of the AnnotationSpecs that had been identified. items format int64 type string type array type object ClipAssetRequest description Request message for ClipAsset API. id ClipAssetRequest properties temporalPartition $ref TemporalPartition description Required. The time range to request clips for. type object ClipAssetResponse description Response message for ClipAsset API. id ClipAssetResponse properties timeIndexedUris description A list of signed uris to download the video clips that cover the requested time range ordered by time. items $ref TimeIndexedUri type array type object Cluster description Message describing the Cluster object. id Cluster properties annotations additionalProperties type string description Annotations to allow clients to store small amounts of arbitrary data. type object createTime description Output only. The create timestamp. format google-datetime readOnly True type string dataplaneServiceEndpoint description Output only. The DNS name of the data plane service readOnly True type string labels additionalProperties type string description Labels as key value pairs type object name description Output only. Name of the resource. readOnly True type string pscTarget description Output only. The private service connection service target name. readOnly True type string state description Output only. The current state of the cluster. enum STATE_UNSPECIFIED PROVISIONING RUNNING STOPPING ERROR enumDescriptions Not set. The PROVISIONING state indicates the cluster is being created. The RUNNING state indicates the cluster has been created and is fully usable. The STOPPING state indicates the cluster is being deleted. The ERROR state indicates the cluster is unusable. It will be automatically deleted. readOnly True type string updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object ClusterInfo id ClusterInfo properties processesCount description The number of active processes in the cluster. format int32 type integer streamsCount description The number of active streams in the cluster. format int32 type integer type object Collection description A collection is a resource in a corpus. It serves as a container of references to original resources. id Collection properties description description Optional. Description of the collection. Can be up to 25000 characters long. type string displayName description Optional. The collection name for displaying. The name can be up to 256 characters long. type string name description Output only. Resource name of the collection. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}` readOnly True type string type object CollectionItem description A CollectionItem is an item in a collection. Each item is a reference to the original resource in a collection. id CollectionItem properties collection description Required. The collection name that this item belongs to. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}` type string itemResource description Required. The name of the CollectionItem. Its format depends on the `type` above. For ASSET: `projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}` type string type description Required. The type of item. enum TYPE_UNSPECIFIED ASSET enumDescriptions The default type of item should never happen. Asset type item. type string type object Corpus description Corpus is a set of media contents for management. Within a corpus, media shares the same data schema. Search is also restricted within a single corpus. id Corpus properties defaultTtl description Optional. The default TTL value for all assets under the corpus without a asset level user-defined TTL. For STREAM_VIDEO type corpora, this is required and the maximum allowed default_ttl is 10 years. format google-duration type string description description Optional. Description of the corpus. Can be up to 25000 characters long. type string displayName description Required. The corpus name to shown in the UI. The name can be up to 32 characters long. type string name description Resource name of the corpus. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}` type string searchCapabilitySetting $ref SearchCapabilitySetting description Default search capability setting on corpus level. type description Optional. Type of the asset inside corpus. enum TYPE_UNSPECIFIED STREAM_VIDEO IMAGE VIDEO_ON_DEMAND enumDescriptions The default type, not supposed to be used. If this default type is used, the corpus will be created as STREAM_VIDEO corpus. Asset is a live streaming video. Asset is an image. Asset is a batch video. type string type object CreateApplicationInstancesRequest description Message for adding stream input to an Application. id CreateApplicationInstancesRequest properties applicationInstances description Required. The resources being created. items $ref ApplicationInstance type array requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). type string type object CreateApplicationInstancesResponse description Message for CreateApplicationInstance Response. id CreateApplicationInstancesResponse properties type object CreateCollectionMetadata description Metadata message for CreateCollectionRequest id CreateCollectionMetadata properties operationMetadata $ref OperationMetadata description Common metadata of the long-running operation. type object CreateCorpusMetadata description Metadata for CreateCorpus API. id CreateCorpusMetadata properties createTime description The create time of the create corpus operation. format google-datetime type string updateTime description The update time of the create corpus operation. format google-datetime type string type object CreateIndexEndpointMetadata description Metadata message for CreateIndexEndpoint. id CreateIndexEndpointMetadata properties operationMetadata $ref OperationMetadata description Common metadata of the long-running operation. type object CreateIndexMetadata description Metadata message for CreateIndexRequest id CreateIndexMetadata properties operationMetadata $ref OperationMetadata description Common metadata of the long-running operation. type object CreateProcessRequest description Message for creating a Process. id CreateProcessRequest properties parent description Required. Value for parent. type string process $ref Process description Required. The resource being created. processId description Required. Id of the requesting object. type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). type string type object Criteria description Filter criteria applied to current search results. id Criteria properties boolValue $ref BoolValue description A Boolean value. dateTimeRangeArray $ref DateTimeRangeArray description The datetime ranges associated with the field. fetchMatchedAnnotations description If true, return query matched annotations for this criteria. This option is only applicable for inclusion criteria, i.e., not exclusion criteria, with partition level annotations. It supports the following data types: - INTEGER - FLOAT - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only) - BOOLEAN type boolean field description The UGA field or ML field to apply filtering criteria. type string floatRangeArray $ref FloatRangeArray description The float ranges associated with the field. geoLocationArray $ref GeoLocationArray description Geo Location array. intRangeArray $ref IntRangeArray description The integer ranges associated with the field. textArray $ref StringArray description The text values associated with the field. type object CustomProcessorSourceInfo description Describes the source info for a custom processor. id CustomProcessorSourceInfo properties additionalInfo additionalProperties type string description Output only. Additional info related to the imported custom processor. Data is filled in by app platform during the processor creation. readOnly True type object modelSchema $ref ModelSchema description Model schema files which specifies the signature of the model. For VERTEX_CUSTOM models, instances schema is required. If instances schema is not specified during the processor creation, VisionAI Platform will try to get it from Vertex, if it doesn't exist, the creation will fail. productRecognizerArtifact $ref ProductRecognizerArtifact description Artifact for product recognizer. sourceType description The original product which holds the custom processor's functionality. enum SOURCE_TYPE_UNSPECIFIED VERTEX_AUTOML VERTEX_CUSTOM PRODUCT_RECOGNIZER enumDescriptions Source type unspecified. Custom processors coming from Vertex AutoML product. Custom processors coming from general custom models from Vertex. Source for Product Recognizer. type string vertexModel description The resource name original model hosted in the vertex AI platform. type string type object CustomRangeBucketSpec description If bucket type is CUSTOM_RANGE, specify how values are bucketized. Use integer bucket value as an example, when the endpoints are 0, 10, 100, and 1000, we will generate the following facets: [-inf, 0), [0, 10), [10, 100), [100, 1000), [1000, inf). Notably: - endpoints must be listed in ascending order. Otherwise, the SearchConfig API will reject the facet config. - < 1 endpoints is an invalid spec. id CustomRangeBucketSpec properties endpoints description Currently, only integer type is supported for this field. items $ref FacetValue type array type object CustomizedStructConfig description The configuration for `CUSTOMIZED_STRUCT` data type. id CustomizedStructConfig properties fieldSchemas additionalProperties $ref DataSchemaDetails description Direct child elements data schemas. type object type object DataSchema description Data schema indicates how the user specified annotation is interpreted in the system. id DataSchema properties key description Required. The key of this data schema. This key should be matching the key of user specified annotation and unique inside corpus. This value can be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number. type string name description Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/corpora/{corpus}/dataSchemas/{data_schema}` where {data_schema} part should be the same as the `key` field below. type string schemaDetails $ref DataSchemaDetails description The schema details mapping to the key. type object DataSchemaDetails description Data schema details indicates the data type and the data struct corresponding to the key of user specified annotation. id DataSchemaDetails properties customizedStructConfig $ref CustomizedStructConfig description Config for CustomizedStruct data type. granularity description The granularity associated with this DataSchema. enum GRANULARITY_UNSPECIFIED GRANULARITY_ASSET_LEVEL GRANULARITY_PARTITION_LEVEL enumDescriptions Unspecified granularity. Asset-level granularity (annotations must not contain partition info). Partition-level granularity (annotations must contain partition info). type string listConfig $ref ListConfig description Config for List data type. protoAnyConfig $ref ProtoAnyConfig description Config for protobuf any type. searchStrategy $ref SearchStrategy description The search strategy to be applied on the `key` above. type description Type of the annotation. enum DATA_TYPE_UNSPECIFIED INTEGER FLOAT STRING DATETIME GEO_COORDINATE PROTO_ANY BOOLEAN LIST CUSTOMIZED_STRUCT enumDescriptions Unspecified type. Integer type. Allowed search strategies: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by IntRangeArray. Float type. Allowed search strategies: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by FloatRangeArray. String type. Allowed search strategies: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH, - DataSchema.SearchStrategy.SMART_SEARCH. Supported formats: %Y-%m-%dT%H:%M:%E*S%E*z (absl::RFC3339_full) %Y-%m-%dT%H:%M:%E*S %Y-%m-%dT%H:%M%E*z %Y-%m-%dT%H:%M %Y-%m-%dT%H%E*z %Y-%m-%dT%H %Y-%m-%d%E*z %Y-%m-%d %Y-%m %Y Allowed search strategies: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by DateTimeRangeArray. Geo coordinate type. Allowed search strategies: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by GeoLocationArray. Type to pass any proto as available in annotations.proto. Only use internally. Available proto types and its corresponding search behavior: - ImageObjectDetectionPredictionResult, allows SMART_SEARCH on display_names and NO_SEARCH. - ClassificationPredictionResult, allows SMART_SEARCH on display_names and NO_SEARCH. - ImageSegmentationPredictionResult, allows NO_SEARCH. - VideoActionRecognitionPredictionResult, allows SMART_SEARCH on display_name and NO_SEARCH. - VideoObjectTrackingPredictionResult, allows SMART_SEARCH on display_name and NO_SEARCH. - VideoClassificationPredictionResult, allows SMART_SEARCH on display_name and NO_SEARCH. - OccupancyCountingPredictionResult, allows EXACT_SEARCH on stats.full_frame_count.count and NO_SEARCH. - ObjectDetectionPredictionResult, allows SMART_SEARCH on identified_boxes.entity.label_string and NO_SEARCH. Boolean type. Allowed search strategies: - DataSchema.SearchStrategy.NO_SEARCH, - DataSchema.SearchStrategy.EXACT_SEARCH. List type. - Each element in the list must be of the exact same data schema; otherwise, they are invalid arguments. - List level cannot set search strategy. Leaf node level can do. - Elements cannot be another list (no list of list). - Elements can be CUSTOMIZED_STRUCT, and max number of layers is 10. Struct type. - SearchStrategy: * Data Schema that's CUSTOMIZED_STRUCT cannot set search strategy. * Leaf-node elements allow setting search strategy based on element's SearchStrategy restriction. - Nested layer restrictions: * Data Schema that's CUSTOMIZED_STRUCT allows its fields to be of CUSTOMIZED_STRUCT as well, but the overall layers restriction is 10. type string type object DateTime description Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. id DateTime properties day description Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. format int32 type integer hours description Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. format int32 type integer minutes description Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. format int32 type integer month description Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. format int32 type integer nanos description Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. format int32 type integer seconds description Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. format int32 type integer timeZone $ref TimeZone description Time zone. utcOffset description UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. format google-duration type string year description Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. format int32 type integer type object DateTimeBucketSpec description If bucket type is DATE, specify how date values are bucketized. id DateTimeBucketSpec properties granularity description Granularity of date type facet. enum GRANULARITY_UNSPECIFIED YEAR MONTH DAY enumDescriptions Unspecified granularity. Granularity is year. Granularity is month. Granularity is day. type string type object DateTimeRange description Datetime range type. id DateTimeRange properties end $ref DateTime description End data time. start $ref DateTime description Start date time. type object DateTimeRangeArray description A list of datetime range values. id DateTimeRangeArray properties dateTimeRanges description Date time ranges. items $ref DateTimeRange type array type object DebugOptions description Options available for debugging purposes only. id DebugOptions properties environmentVariables additionalProperties type string description Environment variables. type object type object DedicatedResources description A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. id DedicatedResources properties autoscalingMetricSpecs description Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. items $ref AutoscalingMetricSpec type array machineSpec $ref MachineSpec description Required. Immutable. The specification of a single machine used by the prediction. maxReplicaCount description Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). format int32 type integer minReplicaCount description Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. format int32 type integer type object DeleteApplicationInstancesRequest description Message for removing stream input from an Application. id DeleteApplicationInstancesRequest properties instanceIds description Required. Id of the requesting object. items type string type array requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). type string type object DeleteApplicationInstancesResponse description Message for DeleteApplicationInstance Response. id DeleteApplicationInstancesResponse properties type object DeleteAssetMetadata description The metadata for DeleteAsset API that embeds in metadata field. id DeleteAssetMetadata properties type object DeleteCollectionMetadata description Metadata message for DeleteCollectionRequest id DeleteCollectionMetadata properties operationMetadata $ref OperationMetadata description Common metadata of the long-running operation. type object DeleteIndexEndpointMetadata description Metadata message for DeleteIndexEndpoint. id DeleteIndexEndpointMetadata properties operationMetadata $ref OperationMetadata description Common metadata of the long-running operation. type object DeleteIndexMetadata description Metadata message for DeleteIndexRequest id DeleteIndexMetadata properties type object DeployApplicationRequest description Message for deploying an Application. id DeployApplicationRequest properties enableMonitoring description Optional. Whether or not to enable monitoring for the application on deployment. type boolean requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). type string validateOnly description If set, validate the request and preview the application graph, but do not actually deploy it. type boolean type object DeployApplicationResponse description RPC Request Messages. Message for DeployApplication Response. id DeployApplicationResponse properties type object DeployIndexMetadata description Metadata message for DeployIndex. id DeployIndexMetadata properties deployedIndex description Output only. The index being deployed. readOnly True type string operationMetadata $ref OperationMetadata description Common metadata of the long-running operation. type object DeployIndexRequest description Request message for DeployIndex. id DeployIndexRequest properties deployedIndex $ref DeployedIndex description Required. Index to deploy. type object DeployIndexResponse description DeployIndex response once the operation is done. id DeployIndexResponse properties type object DeployRetailProductRecognitionIndexRequest description Message for deploying a RetailProductRecognitionIndex to a RetailEndpoint. There could be only one deployed RetailProductRecognitionIndex on a RetailEndpoint. id DeployRetailProductRecognitionIndexRequest properties retailProductRecognitionIndex description Required. The resource name of RetailProductRecognitionIndex to deploy. type string type object DeployRetailProductRecognitionIndexResponse description Message for DeployRetailProductRecognitionIndex response. id DeployRetailProductRecognitionIndexResponse properties type object DeployedIndex description A deployment of an Index. id DeployedIndex properties index description Required. Name of the deployed Index. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}` type string type object DeployedIndexReference description Points to a DeployedIndex. id DeployedIndexReference properties indexEndpoint description Immutable. A resource name of the IndexEndpoint. type string type object DetectedObject description Each DetectedObject is one particular identification of an object specified with the AnnotationSpec id and display_name, the bounding box, the associated confidence score and the corresponding track_id. id DetectedObject properties boundingBox $ref BoundingBox description Boundingbox. confidence description The Model's confidence in correction of this identification, higher value means higher confidence. format float type number displayName description The display name of the AnnotationSpec that had been identified. type string id description The resource ID of the AnnotationSpec that had been identified. type string trackId description The same object may be identified on muitiple frames which are typical adjacent. The set of frames where a particular object has been detected form a track. This track_id can be used to trace down all frames for an detected object. format int64 type string type object DetectedPerson description Detected Person contains the detected person and their associated ppes and their protecting information. id DetectedPerson properties bodyCoverageScore description Coverage score for body. format float type number detectedPersonIdentifiedBox $ref PersonIdentifiedBox description The info of detected person identified box. detectedPpeIdentifiedBoxes description The info of detected person associated ppe identified boxes. items $ref PPEIdentifiedBox type array eyesCoverageScore description Coverage score for eyes. format float type number faceCoverageScore description Coverage score for each body part. Coverage score for face. format float type number feetCoverageScore description Coverage score for feet. format float type number handsCoverageScore description Coverage score for hands. format float type number headCoverageScore description Coverage score for head. format float type number personId description The id of detected person. format int64 type string type object Draft description Message describing Draft object id Draft properties createTime description Output only. [Output only] Create timestamp format google-datetime readOnly True type string description description A description for this application. type string displayName description Required. A user friendly display name for the solution. type string draftApplicationConfigs $ref ApplicationConfigs description The draft application configs which haven't been updated to an application. labels additionalProperties type string description Labels as key value pairs type object name description name of resource type string updateTime description Output only. [Output only] Create timestamp format google-datetime readOnly True type string type object Empty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id Empty properties type object EntityParsingConfig description Configuration for parsing a tag entity class. id EntityParsingConfig properties entityClass description Required. The tag entity class name. This should match the class name produced by the tag entity detection model. type string entityMatchingStrategy description Optional. Entity matching strategy. enum ENTITY_MATCHING_STRATEGY_UNSPECIFIED MULTI_LINE_MATCHING MAX_OVERLAP_AREA enumDescriptions If unspecified, multi-line matching will be used by default. Matches multiple lines of text. Matches the line with the maximum overlap area with entity bounding box. type string regex description Optional. An regular expression hint. type string type object Event description Message describing the Event object. id Event properties alignmentClock description The clock used for joining streams. enum CLOCK_UNSPECIFIED CAPTURE INGEST enumDescriptions Clock is not specified. Use the timestamp when the data is captured. Clients need to sync the clock. Use the timestamp when the data is received. type string annotations additionalProperties type string description Annotations to allow clients to store small amounts of arbitrary data. type object createTime description Output only. The create timestamp. format google-datetime readOnly True type string gracePeriod description Grace period for cleaning up the event. This is the time the controller waits for before deleting the event. During this period, if there is any active channel on the event. The deletion of the event after grace_period will be ignored. format google-duration type string labels additionalProperties type string description Labels as key value pairs. type object name description Name of the resource. type string updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object EventUpdateFilter description EventUpdateFilter is the filter that the watchers can speficy on which event updates that they want to receive. id EventUpdateFilter properties specialMode description Special modes other than a specific timestamp. enum SPECIAL_MODE_UNSPECIFIED BEGINNING LATEST enumDescriptions Special mode unspecified. BEGINNING special mode means all currently available events and incoming event updates. LATEST special mode means only the latest events and incoming event updates. type string specificTime description Specific timestamp after which the event updates happens. format google-datetime type string type object ExportRetailProductRecognitionIndexCoverageRequest description Message for exporting a RetailProductRecognitionIndex coverage file. id ExportRetailProductRecognitionIndexCoverageRequest properties coverageOutput $ref GcsDestination description Required. The Cloud Storage location of the directory where the output file will be written to. If set, this operation will output the index coverage file to the specified location. type object ExportRetailProductRecognitionIndexCoverageResponse description Message for response to exporting RetailProductRecognitionIndex coverage file. id ExportRetailProductRecognitionIndexCoverageResponse properties type object Expr description Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. id Expr properties description description Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. type string expression description Textual representation of an expression in Common Expression Language syntax. type string location description Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. type string title description Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. type string type object FacetBucket description Holds the facet value, selections state, and metadata. id FacetBucket properties range $ref Range description Range value. selected description Whether one facet bucket is selected. This field represents user's facet selection. It is set by frontend in SearchVideosRequest. type boolean value $ref FacetValue description Singular value. type object FacetGroup description A group of facet buckets to be passed back and forth between backend & frontend. id FacetGroup properties bucketType description Facet bucket type. enum FACET_BUCKET_TYPE_UNSPECIFIED FACET_BUCKET_TYPE_VALUE FACET_BUCKET_TYPE_DATETIME FACET_BUCKET_TYPE_FIXED_RANGE FACET_BUCKET_TYPE_CUSTOM_RANGE enumDescriptions Unspecified type. Value type. Datetime type. Fixed Range type. Custom Range type. type string buckets description Buckets associated with the facet. E.g. for "Team" facet, the bucket can be 49ers, patriots, etc. items $ref FacetBucket type array displayName description Display name of the facet. To be used by UI for facet rendering. type string facetId description Unique id of the facet group. type string fetchMatchedAnnotations description If true, return query matched annotations for this facet group's selection. This option is only applicable for facets based on partition level annotations. It supports the following facet values: - INTEGER - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only) type boolean type object FacetProperty description Central configuration for a facet. id FacetProperty properties bucketType description Facet bucket type e.g. value, range. enum FACET_BUCKET_TYPE_UNSPECIFIED FACET_BUCKET_TYPE_VALUE FACET_BUCKET_TYPE_DATETIME FACET_BUCKET_TYPE_FIXED_RANGE FACET_BUCKET_TYPE_CUSTOM_RANGE enumDescriptions Unspecified type. Value type. Datetime type. Fixed Range type. Custom Range type. type string customRangeBucketSpec $ref CustomRangeBucketSpec description Custom range facet bucket config. datetimeBucketSpec $ref DateTimeBucketSpec description Datetime range facet bucket config. displayName description Display name of the facet. To be used by UI for facet rendering. type string fixedRangeBucketSpec $ref FixedRangeBucketSpec description Fixed range facet bucket config. mappedFields description Name of the facets, which are the dimensions users want to use to refine search results. `mapped_fields` will match UserSpecifiedDataSchema keys. For example, user can add a bunch of UGAs with the same key, such as player:adam, player:bob, player:charles. When multiple mapped_fields are specified, will merge their value together as final facet value. E.g. home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = [home_team, away_team], facet_value will be [a, b, c]. UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the mapped_field equals the parent SearchConfig.name, the parent must also contain a SearchCriteriaProperty that maps to the same fields. mapped_fields must not be empty. items type string type array resultSize description Maximum number of unique bucket to return for one facet. Bucket number can be large for high-cardinality facet such as "player". We only return top-n most related ones to user. If it's <= 0, the server will decide the appropriate result_size. format int64 type string type object FacetValue description Definition of a single value with generic type. id FacetValue properties datetimeValue $ref DateTime description Datetime type value. integerValue description Integer type value. format int64 type string stringValue description String type value. type string type object Feature description Feature indicates the ML inference type. id Feature properties productRecognitionConfig $ref RetailProductRecognitionConfig description Optional. Per request overrides for product recognition feature. It's effective only if type is set to TYPE_PRODUCT_RECOGNITION or TYPE_SHELF_HEALTH_ANALYSIS. tagRecognitionConfig $ref RetailTagRecognitionConfig description Optional. Per request overrides for tag recognition feature. It's effective only if type is set to TYPE_TAG_RECOGNITION. type description Required. The Feature Type. enum TYPE_UNSPECIFIED TYPE_PRODUCT_RECOGNITION TYPE_TAG_RECOGNITION enumDescriptions Should not be used. Product Recognition. Must used on an RetailEndpoint with deployed RetailProductRecognitionIndex. Price Tag Detection and Parsing. Must used on an RetailEndpoint with RetailTagRecognitionConfig. type string type object FixedRangeBucketSpec description If bucket type is FIXED_RANGE, specify how values are bucketized. Use FixedRangeBucketSpec when you want to create multiple buckets with equal granularities. Using integer bucket value as an example, when bucket_start = 0, bucket_granularity = 10, bucket_count = 5, this facet will be aggregated via the following buckets: [-inf, 0), [0, 10), [10, 20), [20, 30), [30, inf). Notably, bucket_count <= 1 is an invalid spec. id FixedRangeBucketSpec properties bucketCount description Total number of buckets. format int32 type integer bucketGranularity $ref FacetValue description Bucket granularity. NOTE: Only integer type is currently supported for this field. bucketStart $ref FacetValue description Lower bound of the bucket. NOTE: Only integer type is currently supported for this field. type object FloatRange description Float range type. id FloatRange properties end description End of the float range. format float type number start description Start of the float range. format float type number type object FloatRangeArray description A list of float range values. id FloatRangeArray properties floatRanges description Float range values. items $ref FloatRange type array type object GcsDestination description The Google Cloud Storage location where the output is to be written to. id GcsDestination properties outputUriPrefix description Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. type string type object GcsOutputConfig description Message describing GcsOutputConfig. id GcsOutputConfig properties gcsPath description The Cloud Storage path for Vision AI Platform to ingest annotations to. type string type object GcsSource description The Google Cloud Storage location for the input content. id GcsSource properties uris description Required. References to a Google Cloud Storage paths. items type string type array type object GeneralObjectDetectionConfig description Message of configurations for General Object Detection processor. id GeneralObjectDetectionConfig properties type object GenerateHlsUriRequest description Request message for GenerateHlsUri API. id GenerateHlsUriRequest properties liveViewEnabled description Option to exclusively show a livestream of the asset with up to 3 minutes of backlog data. type boolean temporalPartitions description The time range to request clips for. Will be ignored if `get_live_view` is set to True. The total time range requested should be smaller than 24h. items $ref TemporalPartition type array type object GenerateHlsUriResponse description Response message for GenerateHlsUri API. id GenerateHlsUriResponse properties temporalPartitions description A list of temporal partitions of the content returned in the order they appear in the stream. items $ref TemporalPartition type array uri description A signed uri to download the HLS manifest corresponding to the requested times. type string type object GenerateRetrievalUrlRequest description Request message for GenerateRetrievalUrl API. id GenerateRetrievalUrlRequest properties type object GenerateRetrievalUrlResponse description Response message for GenerateRetrievalUrl API. id GenerateRetrievalUrlResponse properties signedUri description A signed url to download the content of the asset. type string type object GenerateStreamHlsTokenRequest description Request message for getting the auth token to access the stream HLS contents. id GenerateStreamHlsTokenRequest properties type object GenerateStreamHlsTokenResponse description Response message for GenerateStreamHlsToken. id GenerateStreamHlsTokenResponse properties expirationTime description The expiration time of the token. format google-datetime type string token description The generated JWT token. The caller should insert this token to the authorization header of the HTTP requests to get the HLS playlist manifest and the video chunks. eg: curl -H "Authorization: Bearer $TOKEN" https://domain.com/test-stream.playback/master.m3u8 type string type object GeoCoordinate description Location Coordinate Representation id GeoCoordinate properties latitude description Latitude Coordinate. Degrees [-90 .. 90] format double type number longitude description Longitude Coordinate. Degrees [-180 .. 180] format double type number type object GeoLocationArray description A list of locations. id GeoLocationArray properties circleAreas description A list of circle areas. items $ref CircleArea type array type object GetStreamThumbnailResponse description Message for the response of GetStreamThumbnail. The empty response message indicates the thumbnail image has been uploaded to GCS successfully. id GetStreamThumbnailResponse properties type object GlobalOutputResource description Message about output resources from application. id GlobalOutputResource properties key description The key of the output resource, it has to be unique within the same producer node. One producer node can output several output resources, the key can be used to match corresponding output resources. type string outputResource description The full resource name of the outputted resources. type string producerNode description The name of graph node who produces the output resource name. For example: output_resource: /projects/123/locations/us-central1/corpora/my-corpus/dataSchemas/my-schema producer_node: occupancy-count type string type object GraphInputChannelSpec description Message for input channel specification. id GraphInputChannelSpec properties acceptedDataTypeUris description If specified, only those detailed data types can be connected to the processor. For example, jpeg stream for MEDIA, or PredictionResult proto for PROTO type. If unspecified, then any proto is accepted. items type string type array dataType description The data types of the current input channel. When this field has more than 1 value, it means this input channel can be connected to either of these different data types. enum DATA_TYPE_UNSPECIFIED VIDEO IMAGE PROTO PLACEHOLDER enumDescriptions The default value of DataType. Video data type like H264. Image data type. Protobuf data type, usually used for general data blob. A placeholder data type, applicable for the universal input processor which supports any data type. This will be instantiated and replaced by a concrete underlying `DataType` during instance deployment. type string maxConnectionAllowed description How many input edges can be connected to this input channel. 0 means unlimited. format int64 type string name description The name of the current input channel. type string required description Whether the current input channel is required by the processor. For example, for a processor with required video input and optional audio input, if video input is missing, the application will be rejected while the audio input can be missing as long as the video input exists. type boolean type object GraphOutputChannelSpec description Message for output channel specification. id GraphOutputChannelSpec properties dataType description The data type of the current output channel. enum DATA_TYPE_UNSPECIFIED VIDEO IMAGE PROTO PLACEHOLDER enumDescriptions The default value of DataType. Video data type like H264. Image data type. Protobuf data type, usually used for general data blob. A placeholder data type, applicable for the universal input processor which supports any data type. This will be instantiated and replaced by a concrete underlying `DataType` during instance deployment. type string dataTypeUri type string name description The name of the current output channel. type string type object HealthCheckResponse description HealthCheckResponse is the response message for Check. id HealthCheckResponse properties clusterInfo $ref ClusterInfo description Other information of the cluster client may be interested. healthy description Indicates whether the cluster is in healthy state or not. type boolean reason description Reason of why the cluster is in unhealthy state. type string type object IdentifiedAction description Each IdentifiedAction is one particular identification of an action specified with the AnnotationSpec id, display_name and the associated confidence score. id IdentifiedAction properties confidence description The Model's confidence in correction of this identification, higher value means higher confidence. format float type number displayName description The display name of the AnnotationSpec that had been identified. type string id description The resource ID of the AnnotationSpec that had been identified. type string type object IdentifiedClassification description Each IdentifiedClassification is one particular identification of an classification specified with the AnnotationSpec id and display_name, and the associated confidence score. id IdentifiedClassification properties confidence description The Model's confidence in correction of this identification, higher value means higher confidence. format float type number displayName description The display name of the AnnotationSpec that had been identified. type string id description The resource ID of the AnnotationSpec that had been identified. type string type object ImageObjectDetectionPredictionResult description Prediction output format for Image Object Detection. id ImageObjectDetectionPredictionResult properties bboxes description Bounding boxes, i.e. the rectangles over the image, that pinpoint the found AnnotationSpecs. Given in order that matches the IDs. Each bounding box is an array of 4 numbers `xMin`, `xMax`, `yMin`, and `yMax`, which represent the extremal coordinates of the box. They are relative to the image size, and the point 0,0 is in the top left of the image. items items type any type array type array confidences description The Model's confidences in correctness of the predicted IDs, higher value means higher confidence. Order matches the Ids. items format float type number type array displayNames description The display names of the AnnotationSpecs that had been identified, order matches the IDs. items type string type array ids description The resource IDs of the AnnotationSpecs that had been identified, ordered by the confidence score descendingly. It is the id segment instead of full resource name. items format int64 type string type array type object ImageQuery description Image query for search endpoint request. id ImageQuery properties asset description Resource name of the asset. Only supported in IMAGE corpus type. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` type string inputImage description Input image in raw bytes. format byte type string type object ImageSegmentationPredictionResult description Prediction output format for Image Segmentation. id ImageSegmentationPredictionResult properties categoryMask description A PNG image where each pixel in the mask represents the category in which the pixel in the original image was predicted to belong to. The size of this image will be the same as the original image. The mapping between the AnntoationSpec and the color can be found in model's metadata. The model will choose the most likely category and if none of the categories reach the confidence threshold, the pixel will be marked as background. type string confidenceMask description A one channel image which is encoded as an 8bit lossless PNG. The size of the image will be the same as the original image. For a specific pixel, darker color means less confidence in correctness of the cateogry in the categoryMask for the corresponding pixel. Black means no confidence and white means complete confidence. type string type object ImportAssetsMetadata description The metadata message for ImportAssets LRO. id ImportAssetsMetadata properties metadata $ref OperationMetadata description The metadata of the operation. type object ImportAssetsRequest description The request message for ImportAssets. id ImportAssetsRequest properties assetsGcsUri description The file contains all assets information to be imported. * The file is in JSONL format. * Each line corresponding to one asset. * Each line will be converted into InputImageAsset proto. type string type object ImportAssetsResponse description The response message for ImportAssets LRO. id ImportAssetsResponse properties type object ImportRetailProductsRequest description Message for importing RetailProducts. id ImportRetailProductsRequest properties format description Required. The import file format. enum FORMAT_UNSPECIFIED FORMAT_JSONL FORMAT_TXT enumDescriptions Should not be used. JSONL format. TXT format. type string gcsSource $ref GcsSource description Required. The Google Cloud Storage location for the input content. Multiple input locations can be provided. The contents of all input locations will be imported in one batch. Supported file extensions: 1. A JSONL file. Each line is a JSON format of RetailProductIoFormat. 2. A TXT file. Each line is the gtin of a Product to be imported. type object ImportRetailProductsResponse description ImportProducts response once the operation is done. id ImportRetailProductsResponse properties type object Index description An Index is a resource in Corpus. It contains an indexed version of the assets and annotations. When deployed to an endpoint, it will allow users to search the Index. id Index properties createTime description Output only. The create timestamp. format google-datetime readOnly True type string deployedIndexes description Output only. References to the deployed index instance. Index of VIDEO_ON_DEMAND corpus can have at most one deployed index. Index of IMAGE corpus can have multiple deployed indexes. items $ref DeployedIndexReference readOnly True type array description description Optional. Optional description of the index. type string displayName description Optional. Optional user-specified display name of the index. type string entireCorpus description Include all assets under the corpus. type boolean name description Output only. Resource name of the Index resource. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}` readOnly True type string state description Output only. State of the index. enum STATE_UNSPECIFIED CREATING CREATED UPDATING enumDescriptions The default value. Should not be used. State CREATING. State CREATED. State UPDATING. readOnly True type string updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object IndexAssetMetadata description Metadata for IndexAsset. id IndexAssetMetadata properties startTime description The start time of the operation. format google-datetime type string status $ref IndexingStatus description The status of indexing this asset. updateTime description The update time of the operation. format google-datetime type string type object IndexAssetRequest description Request message for IndexAsset. id IndexAssetRequest properties index description Optional. The name of the index. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}` type string type object IndexAssetResponse description Response message for IndexAsset. id IndexAssetResponse properties type object IndexEndpoint description Message representing IndexEndpoint resource. Indexes are deployed into it. id IndexEndpoint properties createTime description Output only. Create timestamp. format google-datetime readOnly True type string deployedIndex $ref DeployedIndex description Output only. The Index deployed in this IndexEndpoint. readOnly True description description Optional. Description of the IndexEndpoint. Can be up to 25000 characters long. type string displayName description Optional. Display name of the IndexEndpoint. Can be up to 32 characters long. type string labels additionalProperties type string description Optional. The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. type object name description Output only. Resource name of the IndexEndpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_id}` readOnly True type string state description Output only. IndexEndpoint state. enum STATE_UNSPECIFIED CREATING CREATED UPDATING FAILED enumDescriptions The default value. Should not be used. State CREATING. State CREATED. State UPDATING. State FAILED. readOnly True type string updateTime description Output only. Update timestamp. format google-datetime readOnly True type string type object IndexedAsset description An IndexedAsset is an asset that the index is built upon. id IndexedAsset properties asset description Required. The resource name of the asset. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` type string createTime description Output only. The create timestamp. format google-datetime readOnly True type string index description Required. The index that this indexed asset belongs to. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}` type string updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object IndexingStatus description The status of indexing for the asset. id IndexingStatus properties state description Output only. State of this asset's indexing. enum STATE_UNSPECIFIED IN_PROGRESS SUCCEEDED FAILED enumDescriptions The default process state should never happen. The indexing is in progress. The process is successfully done. The process failed. readOnly True type string statusMessage description Detailed message describing the state. type string type object InputEdge description Message describing one edge pointing into a node. id InputEdge properties connectedInputChannel description The connected input channel of the current node's processor. It can be omitted if target processor only has 1 input channel. type string parentNode description The name of the parent node. type string parentOutputChannel description The connected output artifact of the parent node. It can be omitted if target processor only has 1 output artifact. type string type object InputResource description Message of input resource used in one application instance. id InputResource properties annotatedStream $ref StreamWithAnnotation deprecated True description If the input resource is VisionAI Stream, the associated annotations can be specified using annotated_stream instead. annotations $ref ResourceAnnotations description Contains resource annotations. consumerNode description The name of graph node who receives the input resource. For example: input_resource: visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a consumer_node: stream-input type string dataType description Data type for the current input resource. enum DATA_TYPE_UNSPECIFIED VIDEO IMAGE PROTO PLACEHOLDER enumDescriptions The default value of DataType. Video data type like H264. Image data type. Protobuf data type, usually used for general data blob. A placeholder data type, applicable for the universal input processor which supports any data type. This will be instantiated and replaced by a concrete underlying `DataType` during instance deployment. type string inputResource description The direct input resource name. If the instance type is STREAMING_PREDICTION, the input resource is in format of "projects/123/locations/us-central1/clusters/456/streams/stream-a". If the instance type is BATCH_PREDICTION from Cloud Storage input container, the input resource is in format of "gs://bucket-a". type string inputResourceBinding description The specific input resource binding which will consume the current Input Resource, can be ignored is there is only 1 input binding. type string type object Instance description Message describing Instance object Next ID: 12 id Instance properties createTime description Output only. [Output only] Create timestamp format google-datetime readOnly True type string description description A description for this instance. type string displayName description Required. A user friendly display name for the solution. type string inputResources description The input resources for the current application instance. For example: input_resources: visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/stream-a items $ref InputResource type array instanceType description The instance type for the current instance. enum INSTANCE_TYPE_UNSPECIFIED STREAMING_PREDICTION BATCH_PREDICTION ONLINE_PREDICTION enumDescriptions Unspecified instance type. If the instance type is not specified, the default one is STREAMING_PREDICTION. Instance type for streaming prediction. Instance type for batch prediction. Instance type for online prediction. type string labels additionalProperties type string description Labels as key value pairs type object name description Output only. name of resource readOnly True type string outputResources description All the output resources associated to one application instance. items $ref OutputResource type array state description State of the instance. enum STATE_UNSPECIFIED CREATING CREATED DEPLOYING DEPLOYED UNDEPLOYING DELETED ERROR UPDATING DELETING FIXING FINISHED enumDescriptions The default value. This value is used if the state is omitted. State CREATING. State CREATED. State DEPLOYING. State DEPLOYED. State UNDEPLOYING. State DELETED. State ERROR. State Updating State Deleting. State Fixing. State Finished. type string updateTime description Output only. [Output only] Update timestamp format google-datetime readOnly True type string type object InstanceResourceInputBindingSpec description Message for instance resource channel specification. External resources are virtual nodes which are not expressed in the application graph. Each processor expresses its out-graph spec, so customer is able to override the external source or destinations to the id InstanceResourceInputBindingSpec properties configTypeUri description The configuration proto that includes the Googleapis resources. I.e. type.googleapis.com/google.cloud.vision.v1.StreamWithAnnotation type string name description Name of the input binding, unique within the processor. type string resourceTypeUri description The direct type url of Googleapis resource. i.e. type.googleapis.com/google.cloud.vision.v1.Asset type string type object InstanceResourceOutputBindingSpec id InstanceResourceOutputBindingSpec properties explicit description Whether the output resource needs to be explicitly set in the instance. If it is false, the processor will automatically generate it if required. type boolean name description Name of the output binding, unique within the processor. type string resourceTypeUri description The resource type uri of the acceptable output resource. type string type object IntRange description Integer range type. id IntRange properties end description End of the int range. format int64 type string start description Start of the int range. format int64 type string type object IntRangeArray description A list of integer range values. id IntRangeArray properties intRanges description Int range values. items $ref IntRange type array type object Lease description The lease message. id Lease properties expireTime description The lease expire time. format google-datetime type string id description The lease id. type string leaseType description The lease type. enum LEASE_TYPE_UNSPECIFIED LEASE_TYPE_READER LEASE_TYPE_WRITER enumDescriptions Lease type unspecified. Lease for stream reader. Lease for stream writer. type string owner description The owner name. type string series description The series name. type string type object ListAnalysesResponse description Message for response to listing Analyses id ListAnalysesResponse properties analyses description The list of Analysis items $ref Analysis type array nextPageToken description A token identifying a page of results the server should return. type string unreachable description Locations that could not be reached. items type string type array type object ListAnnotationsResponse description Request message for ListAnnotations API. id ListAnnotationsResponse properties annotations description The annotations from the specified asset. items $ref Annotation type array nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string type object ListApplicationsResponse description Message for response to listing Applications. id ListApplicationsResponse properties applications description The list of Application. items $ref Application type array nextPageToken description A token identifying a page of results the server should return. type string unreachable description Locations that could not be reached. items type string type array type object ListAssetsResponse description Response message for ListAssets. id ListAssetsResponse properties assets description The assets from the specified corpus. items $ref Asset type array nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string type object ListClustersResponse description Message for response to listing Clusters. id ListClustersResponse properties clusters description The list of Cluster. items $ref Cluster type array nextPageToken description A token identifying a page of results the server should return. type string unreachable description Locations that could not be reached. items type string type array type object ListCollectionsResponse description Response message for ListCollections. id ListCollectionsResponse properties collections description The collections from the specified corpus. items $ref Collection type array nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string type object ListConfig description The configuration for `LIST` data type. id ListConfig properties valueSchema $ref DataSchemaDetails description The value's data schema in the list. type object ListCorporaResponse description Response message for ListCorpora. id ListCorporaResponse properties corpora description The corpora in the project. items $ref Corpus type array nextPageToken description A token to retrieve next page of results. Pass to ListCorporaRequest.page_token to obtain that page. type string type object ListDataSchemasResponse description Response message for ListDataSchemas. id ListDataSchemasResponse properties dataSchemas description The data schemas from the specified corpus. items $ref DataSchema type array nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string type object ListDraftsResponse description Message for response to listing Drafts. id ListDraftsResponse properties drafts description The list of Draft. items $ref Draft type array nextPageToken description A token identifying a page of results the server should return. type string unreachable description Locations that could not be reached. items type string type array type object ListEventsResponse description Message for response to listing Events. id ListEventsResponse properties events description The list of Event. items $ref Event type array nextPageToken description A token identifying a page of results the server should return. type string unreachable description Locations that could not be reached. items type string type array type object ListIndexEndpointsResponse description Response message for ListIndexEndpoints. id ListIndexEndpointsResponse properties indexEndpoints description The list of IndexEndpoints. items $ref IndexEndpoint type array nextPageToken description A token identifying a page of results the server should return. type string type object ListIndexesResponse description Response message for ListIndexes. id ListIndexesResponse properties indexes description The indexes under the specified corpus. items $ref Index type array nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string type object ListInstancesResponse description Message for response to listing Instances. id ListInstancesResponse properties instances description The list of Instance. items $ref Instance type array nextPageToken description A token identifying a page of results the server should return. type string unreachable description Locations that could not be reached. items type string type array type object ListLocationsResponse description The response message for Locations.ListLocations. id ListLocationsResponse properties locations description A list of locations that matches the specified filter in the request. items $ref Location type array nextPageToken description The standard List next-page token. type string type object ListOperationsResponse description The response message for Operations.ListOperations. id ListOperationsResponse properties nextPageToken description The standard List next-page token. type string operations description A list of operations that matches the specified filter in the request. items $ref Operation type array type object ListOperatorsResponse description Message for response to listing Operators. id ListOperatorsResponse properties nextPageToken description A token identifying a page of results the server should return. type string operators description The list of Operator items $ref Operator type array unreachable description Locations that could not be reached. items type string type array type object ListPrebuiltProcessorsRequest description Request Message for listing Prebuilt Processors. id ListPrebuiltProcessorsRequest properties type object ListPrebuiltProcessorsResponse description Response Message for listing Prebuilt Processors. id ListPrebuiltProcessorsResponse properties processors description The list of Processor. items $ref Processor type array type object ListProcessesResponse description Message for response to listing Processes. id ListProcessesResponse properties nextPageToken description A token identifying a page of results the server should return. type string processes description The list of Processes. items $ref Process type array unreachable description Locations that could not be reached. items type string type array type object ListProcessorsResponse description Message for response to listing Processors. id ListProcessorsResponse properties nextPageToken description A token identifying a page of results the server should return. type string processors description The list of Processor. items $ref Processor type array unreachable description Locations that could not be reached. items type string type array type object ListPublicOperatorsResponse description Response message of ListPublicOperators API. id ListPublicOperatorsResponse properties nextPageToken description A token identifying a page of results the server should return. type string operators description The list of Operator items $ref Operator type array type object ListRetailCatalogsResponse description Message for response to listing RetailCatalogs. id ListRetailCatalogsResponse properties nextPageToken description A token identifying a page of results the server should return. type string retailCatalogs description The list of RetailCatalogs. items $ref RetailCatalog type array unreachable description Locations that could not be reached. items type string type array type object ListRetailEndpointsResponse description Message for response to listing RetailEndpoints. id ListRetailEndpointsResponse properties nextPageToken description A token identifying a page of results the server should return. type string retailEndpoints description The list of RetailEndpoints. items $ref RetailEndpoint type array unreachable description Locations that could not be reached. items type string type array type object ListRetailProductImagesResponse description Message for response to listing RetailProductImages. id ListRetailProductImagesResponse properties nextPageToken description A token identifying a page of results the server should return. type string retailProductImages description The list of RetailProductImages. items $ref RetailProductImage type array type object ListRetailProductRecognitionIndexesResponse description Message for response to listing RetailProductRecognitionIndexes. id ListRetailProductRecognitionIndexesResponse properties nextPageToken description A token identifying a page of results the server should return. type string retailProductRecognitionIndexes description The list of RetailProductRecognitionIndexes. items $ref RetailProductRecognitionIndex type array unreachable description Locations that could not be reached. items type string type array type object ListRetailProductSetsResponse description Message for response to listing RetailProductSets. id ListRetailProductSetsResponse properties nextPageToken description A token identifying a page of results the server should return. type string retailProductSets description The list of RetailProductSets. items $ref RetailProductSet type array type object ListRetailProductsResponse description Message for response to listing RetailProducts. id ListRetailProductsResponse properties nextPageToken description A token identifying a page of results the server should return. type string retailProducts description The list of RetailProducts. items $ref RetailProduct type array type object ListSearchConfigsResponse description Response message for ListSearchConfigs. id ListSearchConfigsResponse properties nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string searchConfigs description The search configurations from the specified corpus. items $ref SearchConfig type array type object ListSearchHypernymsResponse description Response message for listing SearchHypernyms. id ListSearchHypernymsResponse properties nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string searchHypernyms description The SearchHypernyms from the specified corpus. items $ref SearchHypernym type array type object ListSeriesResponse description Message for response to listing Series. id ListSeriesResponse properties nextPageToken description A token identifying a page of results the server should return. type string series description The list of Series. items $ref Series type array unreachable description Locations that could not be reached. items type string type array type object ListStreamsResponse description Message for response to listing Streams. id ListStreamsResponse properties nextPageToken description A token identifying a page of results the server should return. type string streams description The list of Stream. items $ref Stream type array unreachable description Locations that could not be reached. items type string type array type object Location description A resource that represents a Google Cloud location. id Location properties displayName description The friendly name for this location, typically a nearby city name. For example, "Tokyo". type string labels additionalProperties type string description Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} type object locationId description The canonical id for this location. For example: `"us-east1"`. type string metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-specific metadata. For example the available capacity at the given location. type object name description Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` type string type object MachineSpec description Specification of a single machine. id MachineSpec properties acceleratorCount description The number of accelerators to attach to the machine. format int32 type integer acceleratorType description Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. enum ACCELERATOR_TYPE_UNSPECIFIED NVIDIA_TESLA_K80 NVIDIA_TESLA_P100 NVIDIA_TESLA_V100 NVIDIA_TESLA_P4 NVIDIA_TESLA_T4 NVIDIA_TESLA_A100 TPU_V2 TPU_V3 enumDescriptions Unspecified accelerator type, which means no accelerator. Nvidia Tesla K80 GPU. Nvidia Tesla P100 GPU. Nvidia Tesla V100 GPU. Nvidia Tesla P4 GPU. Nvidia Tesla T4 GPU. Nvidia Tesla A100 GPU. TPU v2. TPU v3. type string machineType description Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. type string type object MediaWarehouseConfig description Message describing MediaWarehouseConfig. id MediaWarehouseConfig properties corpus description Resource name of the Media Warehouse corpus. Format: projects/${project_id}/locations/${location_id}/corpora/${corpus_id} type string region deprecated True description Deprecated. type string ttl description The duration for which all media assets, associated metadata, and search documents can exist. format google-duration type string type object ModelSchema description The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). id ModelSchema properties instancesSchema $ref GcsSource description Cloud Storage location to a YAML file that defines the format of a single instance used in prediction and explanation requests. parametersSchema $ref GcsSource description Cloud Storage location to a YAML file that defines the prediction and explanation parameters. predictionsSchema $ref GcsSource description Cloud Storage location to a YAML file that defines the format of a single prediction or explanation. type object MonitoringConfig description Monitoring-related configuration for an application. id MonitoringConfig properties enabled description Whether this application has monitoring enabled. type boolean type object Node description Message describing node object. id Node properties displayName description A user friendly display name for the node. type string name description Required. A unique name for the node. type string nodeConfig $ref ProcessorConfig description Node config. outputAllOutputChannelsToStream description By default, the output of the node will only be available to downstream nodes. To consume the direct output from the application node, the output must be sent to Vision AI Streams at first. By setting output_all_output_channels_to_stream to true, App Platform will automatically send all the outputs of the current node to Vision AI Stream resources (one stream per output channel). The output stream resource will be created by App Platform automatically during deployment and deleted after application un-deployment. Note that this config applies to all the Application Instances. The output stream can be override at instance level by configuring the `output_resources` section of Instance resource. `producer_node` should be current node, `output_resource_binding` should be the output channel name (or leave it blank if there is only 1 output channel of the processor) and `output_resource` should be the target output stream. type boolean parents description Parent node. Input node should not have parent node. For V1 Alpha1/Beta only media warehouse node can have multiple parents, other types of nodes will only have one parent. items $ref InputEdge type array processor description Processor name refer to the chosen processor resource. type string type object NodeAnnotation description Message describing annotations specific to application node. id NodeAnnotation properties annotations description The node specific stream annotations. items $ref StreamAnnotation type array node description The node name of the application graph. type string type object NormalizedBoundingBox description Bounding Box in the normalized coordinates. id NormalizedBoundingBox properties height description Height of the bounding box. format float type number width description Width of the bounding box. format float type number xmin description Min in x coordinate. format float type number ymin description Min in y coordinate. format float type number type object NormalizedPolygon description Normalized Polygon. id NormalizedPolygon properties normalizedVertices description The bounding polygon normalized vertices. Top left corner of the image will be [0, 0]. items $ref NormalizedVertex type array type object NormalizedPolyline description Normalized Pplyline, which represents a curve consisting of connected straight-line segments. id NormalizedPolyline properties normalizedVertices description A sequence of vertices connected by straight lines. items $ref NormalizedVertex type array type object NormalizedVertex description A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. id NormalizedVertex properties x description X coordinate. format float type number y description Y coordinate. format float type number type object ObjectDetectionPredictionResult description Prediction output format for Generic Object Detection. id ObjectDetectionPredictionResult properties currentTime description Current timestamp. format google-datetime type string identifiedBoxes description A list of identified boxes. items $ref ObjectDetectionPredictionResultIdentifiedBox type array type object ObjectDetectionPredictionResultEntity description The entity info for annotations from object detection prediction result. id ObjectDetectionPredictionResultEntity properties labelId description Label id. format int64 type string labelString description Human readable string of the label. type string type object ObjectDetectionPredictionResultIdentifiedBox description Identified box contains location and the entity of the object. id ObjectDetectionPredictionResultIdentifiedBox properties boxId description An unique id for this box. format int64 type string confidenceScore description Confidence score associated with this box. format float type number entity $ref ObjectDetectionPredictionResultEntity description Entity of this box. normalizedBoundingBox $ref ObjectDetectionPredictionResultIdentifiedBoxNormalizedBoundingBox description Bounding Box in the normalized coordinates. type object ObjectDetectionPredictionResultIdentifiedBoxNormalizedBoundingBox description Bounding Box in the normalized coordinates. id ObjectDetectionPredictionResultIdentifiedBoxNormalizedBoundingBox properties height description Height of the bounding box. format float type number width description Width of the bounding box. format float type number xmin description Min in x coordinate. format float type number ymin description Min in y coordinate. format float type number type object OccupancyCountConfig description Message describing OccupancyCountConfig. id OccupancyCountConfig properties enableDwellingTimeTracking description Whether to track each invidual object's loitering time inside the scene or specific zone. type boolean enablePeopleCounting description Whether to count the appearances of people, output counts have 'people' as the key. type boolean enableVehicleCounting description Whether to count the appearances of vehicles, output counts will have 'vehicle' as the key. type boolean type object OccupancyCountingPredictionResult description The prediction result proto for occupancy counting. id OccupancyCountingPredictionResult properties currentTime description Current timestamp. format google-datetime type string dwellTimeInfo description Dwell time related information. All the tracks that are live in a given zone with a start and end dwell time timestamp items $ref OccupancyCountingPredictionResultDwellTimeInfo type array identifiedBoxes description A list of identified boxes. items $ref OccupancyCountingPredictionResultIdentifiedBox type array pts description The presentation timestamp of the frame. format int64 type string stats $ref OccupancyCountingPredictionResultStats description Detection statistics. trackInfo description Track related information. All the tracks that are live at this timestamp. It only exists if tracking is enabled. items $ref OccupancyCountingPredictionResultTrackInfo type array type object OccupancyCountingPredictionResultDwellTimeInfo description The dwell time info for annotations from occupancy counting operator. id OccupancyCountingPredictionResultDwellTimeInfo properties dwellEndTime description The end time when a dwelling object has exited in a zone. format google-datetime type string dwellStartTime description The beginning time when a dwelling object has been identified in a zone. format google-datetime type string trackId description An unique id to identify a track. It should be consistent across frames. type string zoneId description The unique id for the zone in which the object is dwelling/waiting. type string type object OccupancyCountingPredictionResultEntity description The entity info for annotations from occupancy counting operator. id OccupancyCountingPredictionResultEntity properties labelId description Label id. format int64 type string labelString description Human readable string of the label. type string type object OccupancyCountingPredictionResultIdentifiedBox description Identified box contains location and the entity of the object. id OccupancyCountingPredictionResultIdentifiedBox properties boxId description An unique id for this box. format int64 type string entity $ref OccupancyCountingPredictionResultEntity description Entity of this box. normalizedBoundingBox $ref OccupancyCountingPredictionResultIdentifiedBoxNormalizedBoundingBox description Bounding Box in the normalized coordinates. score description Confidence score associated with this box. format float type number trackId description An unique id to identify a track. It should be consistent across frames. It only exists if tracking is enabled. format int64 type string type object OccupancyCountingPredictionResultIdentifiedBoxNormalizedBoundingBox description Bounding Box in the normalized coordinates. id OccupancyCountingPredictionResultIdentifiedBoxNormalizedBoundingBox properties height description Height of the bounding box. format float type number width description Width of the bounding box. format float type number xmin description Min in x coordinate. format float type number ymin description Min in y coordinate. format float type number type object OccupancyCountingPredictionResultStats description The statistics info for annotations from occupancy counting operator. id OccupancyCountingPredictionResultStats properties activeZoneCounts description Active zone counts. items $ref OccupancyCountingPredictionResultStatsActiveZoneCount type array crossingLineCounts description Crossing line counts. items $ref OccupancyCountingPredictionResultStatsCrossingLineCount type array fullFrameCount description Counts of the full frame. items $ref OccupancyCountingPredictionResultStatsObjectCount type array type object OccupancyCountingPredictionResultStatsAccumulatedObjectCount description The object info and accumulated count for annotations from occupancy counting operator. id OccupancyCountingPredictionResultStatsAccumulatedObjectCount properties objectCount $ref OccupancyCountingPredictionResultStatsObjectCount description The object count for the accumulated count. startTime description The start time of the accumulated count. format google-datetime type string type object OccupancyCountingPredictionResultStatsActiveZoneCount description Message for the active zone count. id OccupancyCountingPredictionResultStatsActiveZoneCount properties annotation $ref StreamAnnotation description Active zone annotation from the user. counts description Counts in the zone. items $ref OccupancyCountingPredictionResultStatsObjectCount type array type object OccupancyCountingPredictionResultStatsCrossingLineCount description Message for Crossing line count. id OccupancyCountingPredictionResultStatsCrossingLineCount properties accumulatedNegativeDirectionCounts description The accumulated negative count. items $ref OccupancyCountingPredictionResultStatsAccumulatedObjectCount type array accumulatedPositiveDirectionCounts description The accumulated positive count. items $ref OccupancyCountingPredictionResultStatsAccumulatedObjectCount type array annotation $ref StreamAnnotation description Line annotation from the user. negativeDirectionCounts description The direction that is opposite to the right hand rule. items $ref OccupancyCountingPredictionResultStatsObjectCount type array positiveDirectionCounts description The direction that follows the right hand rule. items $ref OccupancyCountingPredictionResultStatsObjectCount type array type object OccupancyCountingPredictionResultStatsObjectCount description The object info and instant count for annotations from occupancy counting operator. id OccupancyCountingPredictionResultStatsObjectCount properties count description Count of the object. format int32 type integer entity $ref OccupancyCountingPredictionResultEntity description Entity of this object. type object OccupancyCountingPredictionResultTrackInfo description The track info for annotations from occupancy counting operator. id OccupancyCountingPredictionResultTrackInfo properties startTime description Start timestamp of this track. format google-datetime type string trackId description An unique id to identify a track. It should be consistent across frames. type string type object Operation description This resource represents a long-running operation that is the result of a network API call. id Operation properties done description If 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. type boolean error $ref Status description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object OperationMetadata description Represents the metadata of the long-running operation. id OperationMetadata properties apiVersion description Output only. API version used to start the operation. readOnly True type string createTime description Output only. The time the operation was created. format google-datetime readOnly True type string endTime description Output only. The time the operation finished running. format google-datetime readOnly True type string requestedCancellation description Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. readOnly True type boolean statusMessage description Output only. Human-readable status of the operation, if any. readOnly True type string target description Output only. Server-defined resource path for the target of the operation. readOnly True type string verb description Output only. Name of the verb executed by the operation. readOnly True type string type object OperationMetrics description The recorded metrics about the operation. id OperationMetrics properties counters additionalProperties format int32 type integer description Mapping from counter name to count. type object type object Operator description Message describing the Operator object. id Operator properties createTime description Output only. The create timestamp. format google-datetime readOnly True type string dockerImage description The link to the docker image of the operator. type string labels additionalProperties type string description Labels as key value pairs. type object name description Name of the resource. type string operatorDefinition $ref OperatorDefinition description The definition of the operator. updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object OperatorDefinition description Defines the interface of an Operator. Arguments to an operator are input/output streams that are getting processesed/returned while attributes are fixed configuration parameters. id OperatorDefinition properties attributes description Declares the attributes. items $ref AttributeDefinition type array description description Full description of the operator. type string inputArgs description Declares input arguments. items $ref ArgumentDefinition type array operator description The name of this operator. Tentatively A-Z*, e.g., BboxCounter, PetDetector, PetDetector1. type string outputArgs description Declares output arguments. items $ref ArgumentDefinition type array resources $ref ResourceSpecification description The resources for running the operator. shortDescription description Short description of the operator. type string type object OperatorOption description Option related to the operator. id OperatorOption properties registry description Registry of the operator. e.g. public, dev. type string tag description Tag of the operator. type string type object OperatorQuery description OperatorQuery represents one query to a Operator. id OperatorQuery properties operator description Required. The canonical Name of the operator. e.g. OccupancyCounting. type string registry description Optional. Registry of the operator. enum REGISTRY_UNSPECIFIED PUBLIC PRIVATE enumDescriptions Registry is unspecified. Public Registry containing the public Operators released by Google. Private Registry containing the local registered operators. type string tag description Optional. Tag of the operator. type string type object Option description Option for one data schema key. id Option properties aggregateMethod description Aggregate method for the current data schema key. enum AGGREGATE_METHOD_UNSPECIFIED AGGREGATE_METHOD_LARGEST AGGREGATE_METHOD_SMALLEST enumDescriptions The unspecified aggregate method will be overwritten as mentioned above. Take the (lexicographical or numerical) largest value to sort. Take the (lexicographical or numerical) smallest value to sort. type string dataSchemaKey description The data used to sort. type string sortDecreasing description Whether to sort in decreasing order or increasing order. By default, results are sorted in incresing order. type boolean type object OutputResource description Message of output resource used in one application instance. id OutputResource properties autogen description Output only. Whether the output resource is created automatically by the Vision AI App Platform. readOnly True type boolean isTemporary description Output only. Whether the output resource is temporary which means the resource is generated during the deployment of the application. Temporary resource will be deleted during the undeployment of the application. readOnly True type boolean outputResource description The output resource name for the current application instance. type string outputResourceBinding description The specific output resource binding which produces the current OutputResource. type string producerNode description The name of graph node who produces the output resource name. For example: output_resource: /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting producer_node: occupancy-counting type string type object PPEEntity description The entity info for annotations from PPE detection prediction result. id PPEEntity properties ppeEntityId description Entity id. format int64 type string ppeLabelId description Label id. format int64 type string ppeLabelString description Human readable string of the label (Examples: helmet, glove, mask). type string ppeSupercategoryLabelString description Human readable string of the super category label (Examples: head_cover, hands_cover, face_cover). type string type object PPEIdentifiedBox description PPEIdentified box contains the location and the entity info of the PPE. id PPEIdentifiedBox properties boxId description An unique id for this box. format int64 type string confidenceScore description Confidence score associated with this box. format float type number normalizedBoundingBox $ref NormalizedBoundingBox description Bounding Box in the normalized coordinates. ppeEntity $ref PPEEntity description PPE entity info. type object Partition description Partition to specify the partition in time and space for sub-asset level annotation. id Partition properties relativeTemporalPartition $ref RelativeTemporalPartition description Partition of asset in time. spatialPartition $ref SpatialPartition description Partition of asset in space. temporalPartition $ref TemporalPartition description Partition of asset in time. type object PersonBlurConfig description Message describing FaceBlurConfig. id PersonBlurConfig properties facesOnly description Whether only blur faces other than the whole object in the processor. type boolean personBlurType description Person blur type. enum PERSON_BLUR_TYPE_UNSPECIFIED FULL_OCCULUSION BLUR_FILTER enumDescriptions PersonBlur Type UNSPECIFIED. FaceBlur Type full occlusion. FaceBlur Type blur filter. type string type object PersonEntity description The entity info for annotations from person detection prediction result. id PersonEntity properties personEntityId description Entity id. format int64 type string type object PersonIdentifiedBox description PersonIdentified box contains the location and the entity info of the person. id PersonIdentifiedBox properties boxId description An unique id for this box. format int64 type string confidenceScore description Confidence score associated with this box. format float type number normalizedBoundingBox $ref NormalizedBoundingBox description Bounding Box in the normalized coordinates. personEntity $ref PersonEntity description Person entity info. type object PersonVehicleDetectionConfig description Message describing PersonVehicleDetectionConfig. id PersonVehicleDetectionConfig properties enablePeopleCounting description At least one of enable_people_counting and enable_vehicle_counting fields must be set to true. Whether to count the appearances of people, output counts have 'people' as the key. type boolean enableVehicleCounting description Whether to count the appearances of vehicles, output counts will have 'vehicle' as the key. type boolean type object PersonalProtectiveEquipmentDetectionConfig description Message describing PersonalProtectiveEquipmentDetectionConfig. id PersonalProtectiveEquipmentDetectionConfig properties enableFaceCoverageDetection description Whether to enable face coverage detection. type boolean enableHandsCoverageDetection description Whether to enable hands coverage detection. type boolean enableHeadCoverageDetection description Whether to enable head coverage detection. type boolean type object PersonalProtectiveEquipmentDetectionOutput description Output format for Personal Protective Equipment Detection Operator. id PersonalProtectiveEquipmentDetectionOutput properties currentTime description Current timestamp. format google-datetime type string detectedPersons description A list of DetectedPersons. items $ref DetectedPerson type array type object Policy description An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). id Policy properties bindings description Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. items $ref Binding type array 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. format byte type string version description Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). format int32 type integer type object Process description Message describing the Process object. id Process properties analysis description Required. Reference to an existing Analysis resource. type string attributeOverrides description Optional. Attribute overrides of the Analyzers. Format for each single override item: "{analyzer_name}:{attribute_key}={value}" items type string type array batchId description Optional. Optional: Batch ID of the Process. type string createTime description Output only. The create timestamp. format google-datetime readOnly True type string eventId description Optional. Event ID of the input/output streams. This is useful when you have a StreamSource/StreamSink operator in the Analysis, and you want to manually specify the Event to read from/write to. type string name description The name of resource. type string retryCount description Optional. Optional: The number of retries for a process in submission mode the system should try before declaring failure. By default, no retry will be performed. format int32 type integer runMode description Optional. Run mode of the Process. enum RUN_MODE_UNSPECIFIED LIVE SUBMISSION enumDescriptions Mode is unspecified. Live mode. Meaning the Process is launched to handle live video source, and possible packet drops are expected. Submission mode. Meaning the Process is launched to handle bounded video files, with no packet drop. Completion status is tracked. type string runStatus $ref RunStatus description Optional. Status of the Process. updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object Processor description Message describing Processor object. Next ID: 19 id Processor properties configurationTypeurl description Output only. The corresponding configuration can be used in the Application to customize the behavior of the processor. readOnly True type string createTime description Output only. [Output only] Create timestamp. format google-datetime readOnly True type string customProcessorSourceInfo $ref CustomProcessorSourceInfo description Source info for customer created processor. description description Illustrative sentences for describing the functionality of the processor. type string displayName description Required. A user friendly display name for the processor. type string labels additionalProperties type string description Labels as key value pairs. type object modelType description Model Type. enum MODEL_TYPE_UNSPECIFIED IMAGE_CLASSIFICATION OBJECT_DETECTION VIDEO_CLASSIFICATION VIDEO_OBJECT_TRACKING VIDEO_ACTION_RECOGNITION OCCUPANCY_COUNTING PERSON_BLUR VERTEX_CUSTOM PRODUCT_RECOGNIZER TAG_RECOGNIZER SYNTH_ID enumDescriptions Processor Type UNSPECIFIED. Model Type Image Classification. Model Type Object Detection. Model Type Video Classification. Model Type Object Tracking. Model Type Action Recognition. Model Type Occupancy Counting. Model Type Person Blur. Model Type Vertex Custom. Model Type Product Recognizer. Model Type Tag Recognizer. Model Type SynthID. type string name description name of resource. type string processorIoSpec $ref ProcessorIOSpec description Output only. [Output only] The input / output specifications of a processor, each type of processor has fixed input / output specs which cannot be altered by customer. readOnly True processorType description Output only. Processor Type. enum PROCESSOR_TYPE_UNSPECIFIED PRETRAINED CUSTOM CONNECTOR enumDescriptions Processor Type UNSPECIFIED. Processor Type PRETRAINED. Pretrained processor is developed by Vision AI App Platform with state-of-the-art vision data processing functionality, like occupancy counting or person blur. Pretrained processor is usually publicly available. Processor Type CUSTOM. Custom processors are specialized processors which are either uploaded by customers or imported from other GCP platform (for example Vertex AI). Custom processor is only visible to the creator. Processor Type CONNECTOR. Connector processors are special processors which perform I/O for the application, they do not processing the data but either deliver the data to other processors or receive data from other processors. readOnly True type string state description Output only. State of the Processor. enum PROCESSOR_STATE_UNSPECIFIED CREATING ACTIVE DELETING FAILED enumDescriptions Unspecified Processor state. Processor is being created (not ready for use). Processor is and ready for use. Processor is being deleted (not ready for use). Processor deleted or creation failed . readOnly True type string supportedAnnotationTypes items enum STREAM_ANNOTATION_TYPE_UNSPECIFIED STREAM_ANNOTATION_TYPE_ACTIVE_ZONE STREAM_ANNOTATION_TYPE_CROSSING_LINE enumDescriptions Type UNSPECIFIED. active_zone annotation defines a polygon on top of the content from an image/video based stream, following processing will only focus on the content inside the active zone. crossing_line annotation defines a polyline on top of the content from an image/video based Vision AI stream, events happening across the line will be captured. For example, the counts of people who goes acroos the line in Occupancy Analytic Processor. type string readOnly True type array supportedInstanceTypes description Which instance types this processor supports; if empty, this default to STREAMING_PREDICTION. items enum INSTANCE_TYPE_UNSPECIFIED STREAMING_PREDICTION BATCH_PREDICTION ONLINE_PREDICTION enumDescriptions Unspecified instance type. If the instance type is not specified, the default one is STREAMING_PREDICTION. Instance type for streaming prediction. Instance type for batch prediction. Instance type for online prediction. type string type array supportsPostProcessing description Indicates if the processor supports post processing. type boolean updateTime description Output only. [Output only] Update timestamp. format google-datetime readOnly True type string type object ProcessorConfig description Next ID: 37 id ProcessorConfig properties aiEnabledDevicesInputConfig $ref AIEnabledDevicesInputConfig description Config of AI-enabled input devices. bigQueryConfig $ref BigQueryConfig description Configs of BigQuery processor. experimentalConfig additionalProperties description Properties of the object. type any description Experimental configurations. Structured object containing not-yet-stable processor parameters. type object gcsOutputConfig $ref GcsOutputConfig description Configs of Cloud Storage output processor. generalObjectDetectionConfig $ref GeneralObjectDetectionConfig description Configs of General Object Detection processor. mediaWarehouseConfig $ref MediaWarehouseConfig description Configs of media warehouse processor. occupancyCountConfig $ref OccupancyCountConfig description Configs of occupancy count processor. personBlurConfig $ref PersonBlurConfig description Configs of person blur processor. personVehicleDetectionConfig $ref PersonVehicleDetectionConfig description Configs of Person Vehicle Detection processor. personalProtectiveEquipmentDetectionConfig $ref PersonalProtectiveEquipmentDetectionConfig description Configs of personal_protective_equipment_detection_config productRecognizerConfig $ref ProductRecognizerConfig description Runtime configs of Product Recognizer processor. tagRecognizerConfig $ref TagRecognizerConfig description Runtime configs of Tag Recognizer processor. universalInputConfig $ref UniversalInputConfig description Runtime configs of UniversalInput processor. vertexAutomlVideoConfig $ref VertexAutoMLVideoConfig description Configs of Vertex AutoML video processor. vertexAutomlVisionConfig $ref VertexAutoMLVisionConfig description Configs of Vertex AutoML vision processor. vertexCustomConfig $ref VertexCustomConfig description Configs of Vertex Custom processor. videoStreamInputConfig $ref VideoStreamInputConfig description Configs of stream input processor. type object ProcessorIOSpec description Message describing the input / output specifications of a processor. id ProcessorIOSpec properties graphInputChannelSpecs description For processors with input_channel_specs, the processor must be explicitly connected to another processor. items $ref GraphInputChannelSpec type array graphOutputChannelSpecs description The output artifact specifications for the current processor. items $ref GraphOutputChannelSpec type array instanceResourceInputBindingSpecs description The input resource that needs to be fed from the application instance. items $ref InstanceResourceInputBindingSpec type array instanceResourceOutputBindingSpecs description The output resource that the processor will generate per instance. Other than the explicitly listed output bindings here, all the processors' GraphOutputChannels can be binded to stream resource. The bind name then is the same as the GraphOutputChannel's name. items $ref InstanceResourceOutputBindingSpec type array type object ProductRecognizerArtifact description Message describes product recognizer artifact. id ProductRecognizerArtifact properties retailProductRecognitionIndex description Required. Resource name of RetailProductRecognitionIndex. Format is 'projects/*/locations/*/retailCatalogs/*/retailProductRecognitionIndexes/*' type string vertexModel description Optional. The resource name of embedding model hosted in Vertex AI Platform. type string type object ProductRecognizerConfig description Message describing ProductRecognizerConfig. id ProductRecognizerConfig properties recognitionConfidenceThreshold description Confidence threshold to filter detection results. If not set, a system default value will be used. format float type number retailEndpoint description The resource name of retail endpoint to use. type string type object ProtoAnyConfig description The configuration for `PROTO_ANY` data type. id ProtoAnyConfig properties typeUri description The type URI of the proto message. type string type object Range description The range of values [start, end) for which faceting is applied. id Range properties end $ref FacetValue description End of the range. Non-existence indicates some bound (e.g. inf). start $ref FacetValue description Start of the range. Non-existence indicates some bound (e.g. -inf). type object RelativeTemporalPartition description Partition of asset in relative time. Supported by VIDEO_ON_DEMAND corpus type. id RelativeTemporalPartition properties endOffset description End time offset of the partition. format google-duration type string startOffset description Start time offset of the partition. format google-duration type string type object ReleaseLeaseRequest description Request message for releasing lease. id ReleaseLeaseRequest properties id description Lease id. type string owner description Lease owner. type string type object ReleaseLeaseResponse description Response message for release lease. id ReleaseLeaseResponse properties type object RemoveApplicationStreamInputRequest description Message for removing stream input from an Application. id RemoveApplicationStreamInputRequest properties requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). type string targetStreamInputs description The target stream to remove. items $ref TargetStreamInput type array type object RemoveApplicationStreamInputResponse description Message for RemoveApplicationStreamInput Response. id RemoveApplicationStreamInputResponse properties type object RemoveCollectionItemRequest description Request message for RemoveCollectionItem. id RemoveCollectionItemRequest properties item $ref CollectionItem description Required. The item to be removed. type object RemoveCollectionItemResponse description Request message for RemoveCollectionItem. id RemoveCollectionItemResponse properties item $ref CollectionItem description The item that has already been removed. type object RemoveIndexAssetMetadata description Metadata for RemoveIndexAsset. id RemoveIndexAssetMetadata properties indexingStatus $ref IndexingStatus description The status of indexing this asset. startTime description The start time of the operation. format google-datetime type string updateTime description The update time of the operation. format google-datetime type string type object RemoveIndexAssetRequest description Request message for RemoveIndexAsset. id RemoveIndexAssetRequest properties index description Optional. The name of the index. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}` type string type object RemoveIndexAssetResponse description Response message for RemoveIndexAsset. id RemoveIndexAssetResponse properties type object RemoveRetailProductsFromRetailProductSetRequest description Message for removing RetailProducts from RetailProductSet. id RemoveRetailProductsFromRetailProductSetRequest properties productFilter deprecated True description Deprecated. Use product_ids instead. A standard filter that will be applied to all RetailProducts in the specified RetailProductSet, select items which satisfy filter condition and remove them from the ReatilProductSet. Cannot be used together with product_ids. Supported filters: https://google.aip.dev/160 type string productIds description Resource ids of the RetailProducts to be removed. If the specified RetailProducts does not belong to this RetailProductSet, it will be ignored. Up to 200 RetailProducts ids can be specified in one request.Can not be used together with products_filter. items type string type array type object RemoveRetailProductsFromRetailProductSetResponse description RemoveRetailProductsFromRetailProductSet response once the operation is done. id RemoveRetailProductsFromRetailProductSetResponse properties type object RenewLeaseRequest description Request message for renewing a lease. id RenewLeaseRequest properties id description Lease id. type string owner description Lease owner. type string term description Lease term. format google-duration type string type object ResolveOperatorInfoRequest description Request message for querying operator info. id ResolveOperatorInfoRequest properties queries description Required. The operator queries. items $ref OperatorQuery type array type object ResolveOperatorInfoResponse description Response message of ResolveOperatorInfo API. id ResolveOperatorInfoResponse properties operators description Operators with detailed information. items $ref Operator type array type object ResourceAnnotations description Message describing general annotation for resources. id ResourceAnnotations properties applicationAnnotations description Annotations that will be applied to the whole application. items $ref StreamAnnotation type array nodeAnnotations description Annotations that will be applied to the specific node of the application. If the same type of the annotations is applied to both application and node, the node annotation will be added in addition to the global application one. For example, if there is one active zone annotation for the whole application and one active zone annotation for the Occupancy Analytic processor, then the Occupancy Analytic processor will have two active zones defined. items $ref ApplicationNodeAnnotation type array type object ResourceSpecification description ResourceSpec collects a set of resources that can be used to specify requests and requirements. Note: Highly experimental as this can be runtime dependent. Can use the "extras" field to experiment first before trying to abstract it. id ResourceSpecification properties cpu description CPU specification. Examples: "100m", "0.5", "1", "2", ... correspond to 0.1, half, 1, or 2 cpus. Leave empty to let the system decide. Note that this does *not* determine the cpu vender/make, or its underlying clock speed and specific SIMD features. It is only the amount time it requires in timeslicing. type string cpuLimits description CPU limit. Examples: "100m", "0.5", "1", "2", ... correspond to 0.1, half, 1, or 2 cpus. Leave empty to indicate no limit. type string gpus description Number of gpus. format int32 type integer latencyBudgetMs description The maximum latency that this operator may use to process an element. If non positive, then a system default will be used. Operator developers should arrange for the system compute resources to be aligned with this latency budget; e.g. if you want a ML model to produce results within 500ms, then you should make sure you request enough cpu/gpu/memory to achieve that. format int32 type integer memory description Memory specification (in bytes). Examples: "128974848", "129e6", "129M", "123Mi", ... correspond to 128974848 bytes, 129000000 bytes, 129 mebibytes, 123 megabytes. Leave empty to let the system decide. type string memoryLimits description Memory usage limits. Examples: "128974848", "129e6", "129M", "123Mi", ... correspond to 128974848 bytes, 129000000 bytes, 129 mebibytes, 123 megabytes. Leave empty to indicate no limit. type string type object RetailBatchAnalyzeRequest description Message for performing batch ML inference on a given RetailEndpoint. id RetailBatchAnalyzeRequest properties bigqueryTable description Optional. Resource name of the bigquery table for annotation exports. In the format of "projects/*/datasets/*/tables/*". If set, annotations generated from ML inference will also be exported to the given bigquery table. type string corpus description Optional. Resource name of image warehouse corpus. type string features description Required. The type of ML inference to perform. items $ref Feature type array gcsSource $ref GcsSource description Optional. The Google Cloud Storage location for the input content. Multiple input locations can be provided. The contents of all input locations will be processed in one batch. Supported formats are either a TXT or CSV file where each line is the full path to an image. A maximum of 10k images can be supported in one request. outputGcsDestination $ref GcsDestination description Optional. The Cloud Storage location of the directory where the output is to be written to. type object RetailBatchAnalyzeResponse description Response message for BatchAnalyze. id RetailBatchAnalyzeResponse properties type object RetailCatalog description Message representing the RetailCatalog resource. id RetailCatalog properties createTime description Output only. The create timestamp. format google-datetime readOnly True type string description description Optional. Description of the RetailCatalog. type string displayName description Optional. Display name of the RetailCatalog. type string labels additionalProperties type string description The labels with user-defined metadata to organize your RetailCatalog. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. type object name description Output only. Name of the RetailCatalog resource. readOnly True type string resourceState description Output only. State of the RetailCatalog. enum RETAIL_RESOURCE_STATE_UNSPECIFIED RETAIL_RESOURCE_STATE_CREATING RETAIL_RESOURCE_STATE_CREATED RETAIL_RESOURCE_STATE_UPDATING RETAIL_RESOURCE_STATE_DELETED RETAIL_RESOURCE_STATE_ERROR enumDescriptions The default value. Should not be used. State CREATING. State CREATED. State UPDATING. State DELETED. State ERROR. readOnly True type string updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object RetailEndpoint description Message describing the RetailEndpoint object. id RetailEndpoint properties createTime description Output only. The create timestamp. format google-datetime readOnly True type string deployedProductRecognitionIndex description Output only. Resource name of the ProductRecognitionIndex deployed to this RetailEndpoint. readOnly True type string description description Optional. The description of the RetailEndpoint. type string displayName description Optional. Display name of the RetailEndpoint. type string labels additionalProperties type string description The labels with user-defined metadata to organize your RetailEndpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. type object name description Output only. Resource name of the RetailEndpoint resource. readOnly True type string productRecognitionConfig $ref RetailProductRecognitionConfig description Optional. Configuration for product recognition. resourceState description Output only. State of the RetailEndpoint. enum RETAIL_RESOURCE_STATE_UNSPECIFIED RETAIL_RESOURCE_STATE_CREATING RETAIL_RESOURCE_STATE_CREATED RETAIL_RESOURCE_STATE_UPDATING RETAIL_RESOURCE_STATE_DELETED RETAIL_RESOURCE_STATE_ERROR enumDescriptions The default value. Should not be used. State CREATING. State CREATED. State UPDATING. State DELETED. State ERROR. readOnly True type string tagRecognitionConfig $ref RetailTagRecognitionConfig description Optional. Configuration for tag recognition. updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object RetailEntity description An entity that could be a phrase or a number in the tag text. It is a known entity type, such as a product title, regular price, or club price. id RetailEntity properties confidence description Confidence of the entity prediction. format float type number mentionText description Text value of the entity e.g. '$2.99'. If the entity is not present in the tag, this field will be empty. type string normalizedTextValue description Normalized text value in a pre-defined standard for the entity type. Absent if the extracted value could not be converted. type string region $ref RetailNormalizedBoundingBox description The location region of the entity in the tag region. type description Entity type e.g. 'product title', 'regular price', 'club price'. type string type object RetailNormalizedBoundingBox description Bounding box coordinates are relative to the width and height of the image. For example, if image is 100x200 and NormalizedBoundingBox is , the bounding box coordinates will be (10, 40) to (50, 180). Note parts of the bounding box may fall outside the image. id RetailNormalizedBoundingBox properties xMax description Horizontal coordinate of bottom right corner. format float type number xMin description Horizontal coordinate of upper left corner. format float type number yMax description Vertical coordinate of bottom right corner. format float type number yMin description Vertical coordinate of upper left corner. format float type number type object RetailObjectDetectionAnnotation description Describe an object region and its detection annotation in an image. id RetailObjectDetectionAnnotation properties boundingBox $ref RetailNormalizedBoundingBox description Normalized bounding box of the object instance. confidence description A confidence score between 0.0 and 1.0. A higher value means greater confidence about the result. format float type number type object RetailOperationMetadata description Operation Metadata for Reatil Service. id RetailOperationMetadata properties operationMetadata $ref OperationMetadata description Common metadata of the long-running operation. operationMetrics $ref OperationMetrics description Output only. Metrics about the operation. readOnly True partialFailures description Output only. Partial failures encountered. E.g. single image file that couldn't be read. Status details field will contain standard GCP error details. items $ref Status readOnly True type array type object RetailPredictResults description Result format of BatchAnalyze. id RetailPredictResults properties imageUri description Image uri from input. type string productDetectionAnnotations description Product detection annotations. items $ref RetailObjectDetectionAnnotation type array productRecognitionAnnotations description Product recognition annotations. items $ref RetailProductRecognitionAnnotation type array tagRecognitionAnnotations description Tag recognition annotations. items $ref RetailTagRecognitionAnnotation type array type object RetailProduct description Message representing the RetailProduct resource. id RetailProduct properties brand description Localized brand of the product. type string createTime description Output only. The create timestamp. format google-datetime readOnly True type string gtins description The Global Trade Item Number (GTIN) of the product. items type string type array labels additionalProperties type string description The labels with user-defined metadata to organize your RetailProducts. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. type object locale description Locale of the product information represented as BCP-47 code, e.g., en-US, de-DE. The language of the product label and the brand should match the language of the locale. type string name description Output only. Name of the RetailProduct resource. readOnly True type string normalizedGtins description Output only. The normalized version from input gtins into the canonical GTIN-14 format. items type string readOnly True type array productUri description Landing page for the product. type string resourceState description Output only. State of the RetailProduct. enum RETAIL_RESOURCE_STATE_UNSPECIFIED RETAIL_RESOURCE_STATE_CREATING RETAIL_RESOURCE_STATE_CREATED RETAIL_RESOURCE_STATE_UPDATING RETAIL_RESOURCE_STATE_DELETED RETAIL_RESOURCE_STATE_ERROR enumDescriptions The default value. Should not be used. State CREATING. State CREATED. State UPDATING. State DELETED. State ERROR. readOnly True type string thirdPartyIds description Third-party identifiers used by retailer or manufacturer. items $ref RetailThirdPartyId type array title description Localized title of the product. type string updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object RetailProductImage description Message representing the RetailProductImage resource. id RetailProductImage properties createTime description Output only. The create timestamp. format google-datetime readOnly True type string displayName description Optional. Display name of the RetailProductImage. type string gcsUri description Optional. Google Cloud Storage location of the RetailProductImage. It should be set except when the image is provided by Google, i.e., when the source type is SOURCE_TYPE_GOOGLE. type string labels additionalProperties type string description The labels with user-defined metadata to organize your RetailProductImages. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. type object name description Output only. Resource name of the RetailProductImage. readOnly True type string resourceState description Output only. State of the RetailProductImage. enum RETAIL_RESOURCE_STATE_UNSPECIFIED RETAIL_RESOURCE_STATE_CREATING RETAIL_RESOURCE_STATE_CREATED RETAIL_RESOURCE_STATE_UPDATING RETAIL_RESOURCE_STATE_DELETED RETAIL_RESOURCE_STATE_ERROR enumDescriptions The default value. Should not be used. State CREATING. State CREATED. State UPDATING. State DELETED. State ERROR. readOnly True type string sourceType description Optional. Source type enum SOURCE_TYPE_UNSPECIFIED SOURCE_TYPE_FIXED_CAMERA SOURCE_TYPE_HAND_HELD_CAMERA SOURCE_TYPE_CRAWLED SOURCE_TYPE_SYSTEM_GENERATED SOURCE_TYPE_USER_PROVIDED enumDescriptions Unknown data source. Image is captured from fixed camera. Image is captured from hand-held camera. Image is crawled from the web. Image is cropped from an original image with human labeling. Image is provided by user. type string updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object RetailProductImageSimilarity description The similarity scores to the product image in the index set. id RetailProductImageSimilarity properties detectedTextSimilarityScore description The similarity score between the detected text in the query product image to the model detected text in this product image. format float type number productTitleTextSimilarityScore description The similarity score between the detected text in the query product image to the human curated product title of this product image. format float type number similarityScore description The final combined similarity score to this product image. format float type number visualSimilarityScore description The visual similarity score to this product image. format float type number type object RetailProductRecognitionAnnotation description Describe a product region and its product recognition annotation in an image. id RetailProductRecognitionAnnotation properties detectedText description Text detected by the model in this product_region. type string productRegion $ref RetailObjectDetectionAnnotation description Detection information about this product instance (bounding box, confidence etc.). recognitionResults description Results of the product recognition. They are sorted by decreasing confidence. items $ref RetailProductRecognitionResult type array type object RetailProductRecognitionConfig description Configuration for product recognition. id RetailProductRecognitionConfig properties additionalConfig additionalProperties description Properties of the object. type any description Optional. Additional configurations for product recognition. type object detectionConfidenceThreshold description Optional. Confidence threshold to filter detection results. If not set, a system default value will be used. format float type number productDetectionModel description Optional. Model to use to detect products in input images. Supported values: "builtin/stable" (the default) or Vertex AI model resource name. type string recognitionConfidenceThreshold description Optional. Confidence threshold to filter recognition results. If not set, a system default value will be used. format float type number type object RetailProductRecognitionIndex description RetailProductRecognitionIndex is a materialization of the current state of a set of Products either from the specified RetailProductSet or the entire RetailCatalog. It's the data format ready to be deployed to an RetailEndpoint and serve incoming recognition requests. id RetailProductRecognitionIndex properties createTime description Output only. The create timestamp. format google-datetime readOnly True type string description description Optional. The description of the RetailProductRecognitionIndex. type string displayName description Optional. Display name of the RetailProductRecognitionIndex. type string labels additionalProperties type string description The labels with user-defined metadata to organize your RetailProductRecognitionIndexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. type object name description Output only. Resource name of the RetailProductRecognitionIndex resource. readOnly True type string resourceState description Output only. State of the RetailProductRecognitionIndex. enum RETAIL_RESOURCE_STATE_UNSPECIFIED RETAIL_RESOURCE_STATE_CREATING RETAIL_RESOURCE_STATE_CREATED RETAIL_RESOURCE_STATE_UPDATING RETAIL_RESOURCE_STATE_DELETED RETAIL_RESOURCE_STATE_ERROR enumDescriptions The default value. Should not be used. State CREATING. State CREATED. State UPDATING. State DELETED. State ERROR. readOnly True type string retailProductSet description Optional. The resource name of RetailProductSet to use for creating this resource. If set, the RetailProductRecognitionIndex will only contain products in the given RetailProductSet. If not set, all products in the parent catalog will be used. items type string type array updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object RetailProductRecognitionResult description Single product recognition result. id RetailProductRecognitionResult properties confidence description A confidence score between 0.0 and 1.0. A higher value means greater confidence about the result. format float type number imageSimilarity description The similarity score details to each product image for this result. items $ref RetailProductImageSimilarity type array productMetadata $ref RetailProduct description Metadata of the recognized product. type object RetailProductSet description Represents an arbitrary set containing multiple products of the catalog. The RetailProductSet is useful to organize products in a catalog structurally. id RetailProductSet properties createTime description Output only. The create timestamp. format google-datetime readOnly True type string displayName description Optional. Display name of the RetailProductSet. type string labels additionalProperties type string description The labels with user-defined metadata to organize your RetailProductSets. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. type object name description Output only. Resource name of the RetailProductSet. readOnly True type string resourceState description Output only. State of the RetailProductSet. enum RETAIL_RESOURCE_STATE_UNSPECIFIED RETAIL_RESOURCE_STATE_CREATING RETAIL_RESOURCE_STATE_CREATED RETAIL_RESOURCE_STATE_UPDATING RETAIL_RESOURCE_STATE_DELETED RETAIL_RESOURCE_STATE_ERROR enumDescriptions The default value. Should not be used. State CREATING. State CREATED. State UPDATING. State DELETED. State ERROR. readOnly True type string retailProductIds description Output only. Resource ids of products belonging to this RetailProductSet. The products in a RetailProductSet should be under the same catalog. items type string readOnly True type array updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object RetailTagRecognitionAnnotation description A proto describes recognition result of a tag, including the region of image occupied by this tag instance and extracted text information. id RetailTagRecognitionAnnotation properties entities description A list of entities detected in the tag. items $ref RetailEntity type array tagRegion $ref RetailObjectDetectionAnnotation description Detection information about this tag instance (bounding box, confidence etc.). tagText description Text on this tag instance. type string type object RetailTagRecognitionConfig description Configuration for tag recognition. id RetailTagRecognitionConfig properties additionalConfig additionalProperties description Properties of the object. type any description Optional. Additional configurations for tag recognition. type object detectionConfidenceThreshold description Optional. Confidence threshold to filter detection results. If not set, a system default value will be used. format float type number entityDetectionModel description Optional. Either tag_parsing_model or entity_detection_model must be set. Model to detect entities in tags as part of a customized tag parsing model. If using a customized tag parsing model, then both this field and additional_config must be set. This should be a Vertex AI Model resource name in the format "projects/{project}/locations/{location}/models/{model}". type string parsingConfidenceThreshold description Optional. Confidence threshold to filter text parsing results. If not set, a system default value will be used. format float type number tagDetectionModel description Optional. Model to use to detect tags in input images. Supported values: "builtin/stable" (the default) or Vertex AI model resource. type string tagParsingModel description Optional. Either tag_parsing_model or entity_detection_model must be set. Model to parse text on detected tags. This field will be deprecated before GA. type string type object RetailThirdPartyId description Represents third party identifier used by the retailer or manufacturer (e.g., SKU or MPN). id RetailThirdPartyId properties id description Third party id used by the retailer or manufacturer (e.g., SKU or MPN). type string owner description The entity that 'owns' the third party identifier, i.e., the manufacturer or the retailer selling this product. type string type object RunStatus description Message describing the status of the Process. id RunStatus properties reason description The reason of becoming the state. type string state description The state of the Process. enum STATE_UNSPECIFIED INITIALIZING RUNNING COMPLETED FAILED PENDING enumDescriptions State is unspecified. INITIALIZING means the Process is scheduled but yet ready to handle real traffic. RUNNING means the Process is up running and handling traffic. COMPLETED means the Process has completed the processing, especially for non-streaming use case. FAILED means the Process failed to complete the processing. PENDING means the Process is created but yet to be scheduled. type string type object SchemaKeySortingStrategy description A strategy to specify how to sort by data schema key. id SchemaKeySortingStrategy properties options description Options in the front have high priority than those in the back. items $ref Option type array type object SearchAssetsRequest description Request message for SearchAssets. id SearchAssetsRequest properties contentTimeRanges $ref DateTimeRangeArray description Time ranges that matching video content must fall within. If no ranges are provided, there will be no time restriction. This field is treated just like the criteria below, but defined separately for convenience as it is used frequently. Note that if the end_time is in the future, it will be clamped to the time the request was received. criteria description Criteria applied to search results. items $ref Criteria type array facetSelections description Stores most recent facet selection state. Only facet groups with user's selection will be presented here. Selection state is either selected or unselected. Only selected facet buckets will be used as search criteria. items $ref FacetGroup type array pageSize description The number of results to be returned in this page. If it's 0, the server will decide the appropriate page_size. format int32 type integer pageToken description The continuation token to fetch the next page. If empty, it means it is fetching the first page. type string resultAnnotationKeys description A list of annotation keys to specify the annotations to be retrieved and returned with each search result. Annotation granularity must be GRANULARITY_ASSET_LEVEL and its search strategy must not be NO_SEARCH. items type string type array schemaKeySortingStrategy $ref SchemaKeySortingStrategy description Sort by the value under the data schema key. searchQuery description Global search query. Allows user to search assets without needing to specify which field the value belongs to. type string type object SearchAssetsResponse description Response message for SearchAssets. id SearchAssetsResponse properties facetResults description Facet search results of a given query, which contains user's already-selected facet values and updated facet search results. items $ref FacetGroup type array nextPageToken description The next-page continuation token. type string searchResultItems description Returned search results. items $ref SearchResultItem type array type object SearchCapability description The capability and metadata of search capability. id SearchCapability properties type description The search capability to enable. enum TYPE_UNSPECIFIED EMBEDDING_SEARCH enumDescriptions Unspecified search capability, should never be used. Embedding search. type string type object SearchCapabilitySetting description Setting for search capability to enable. id SearchCapabilitySetting properties searchCapabilities description The metadata of search capability to enable. items $ref SearchCapability type array type object SearchConfig description SearchConfig stores different properties that will affect search behaviors and search results. id SearchConfig properties facetProperty $ref FacetProperty description Establishes a FacetDimension and associated specifications. name description Resource name of the search configuration. For CustomSearchCriteria, search_config would be the search operator name. For Facets, search_config would be the facet dimension name. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}` type string searchCriteriaProperty $ref SearchCriteriaProperty description Creates a mapping between a custom SearchCriteria and one or more UGA keys. type object SearchCriteriaProperty description Central configuration for custom search criteria. id SearchCriteriaProperty properties mappedFields description Each mapped_field corresponds to a UGA key. To understand how this property works, take the following example. In the SearchConfig table, the user adds this entry: search_config { name: "person" search_criteria_property { mapped_fields: "player" mapped_fields: "coach" } } Now, when a user issues a query like: criteria { field: "person" text_array { txt_values: "Tom Brady" txt_values: "Bill Belichick" } } MWH search will return search documents where (player=Tom Brady || coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick). items type string type array type object SearchHypernym description Search resource: SearchHypernym. For example, { hypernym: "vehicle" hyponyms: ["sedan", "truck"] } This means in SMART_SEARCH mode, searching for "vehicle" will also return results with "sedan" or "truck" as annotations. id SearchHypernym properties hypernym description The hypernym. type string hyponyms description Hyponyms that the hypernym is mapped to. items type string type array name description Resource name of the SearchHypernym. Format: `projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}` type string type object SearchIndexEndpointRequest description Request message for SearchIndexEndpoint. id SearchIndexEndpointRequest properties criteria description Criteria applied to search results. items $ref Criteria type array exclusionCriteria description Criteria to exclude from search results. Note that `fetch_matched_annotations` will be ignored. items $ref Criteria type array imageQuery $ref ImageQuery description An image-only query. pageSize description Requested page size. API may return fewer results than requested. If negative, INVALID_ARGUMENT error will be returned. If unspecified or 0, API will pick a default size, which is 10. If the requested page size is larger than the maximum size, API will pick the maximum size, which is 100. format int32 type integer pageToken description The continuation token to fetch the next page. If empty, it means it is fetching the first page. type string textQuery description A text-only query. type string type object SearchIndexEndpointResponse description Response message for SearchIndexEndpoint. id SearchIndexEndpointResponse properties nextPageToken description The next-page continuation token. If this field is omitted, there are no subsequent pages. type string searchResultItems description Returned search results. items $ref SearchResultItem type array type object SearchResultItem description Search result contains asset name and corresponding time ranges. id SearchResultItem properties annotationMatchingResults description Criteria or facet-selection based annotation matching results associated to this search result item. Only contains results for criteria or facet_selections with fetch_matched_annotations=true. items $ref AnnotationMatchingResult type array asset description The resource name of the asset. Format: `projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/assets/{asset_id}` type string relevance description Relevance of this `SearchResultItem` to user search request. Currently available only in Image Warehouse, and by default represents cosine similarity. In the future can be other measures such as "dot product" or "topicality" requested in the search request. format double type number requestedAnnotations description Search result annotations specified by result_annotation_keys in search request. items $ref Annotation type array segment $ref TemporalPartition description The matched asset segment. segments deprecated True description The matched asset segments. Deprecated: please use singular `segment` field. items $ref TemporalPartition type array type object SearchStrategy description The search strategy for annotations value of the `key`. id SearchStrategy properties searchStrategyType description The type of search strategy to be applied on the `key` above. The allowed `search_strategy_type` is different for different data types, which is documented in the DataSchemaDetails.DataType. Specifying unsupported `search_strategy_type` for data types will result in INVALID_ARGUMENT error. enum NO_SEARCH EXACT_SEARCH SMART_SEARCH enumDescriptions Annotatation values of the `key` above will not be searchable. When searching with `key`, the value must be exactly as the annotation value that has been ingested. When searching with `key`, Warehouse will perform broad search based on semantic of the annotation value. type string type object Series description Message describing the Series object. id Series properties annotations additionalProperties type string description Annotations to allow clients to store small amounts of arbitrary data. type object createTime description Output only. The create timestamp. format google-datetime readOnly True type string event description Required. Event that is associated with this series. type string labels additionalProperties type string description Labels as key value pairs. type object name description Name of the resource. type string stream description Required. Stream that is associated with this series. type string updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object SetIamPolicyRequest description Request message for `SetIamPolicy` method. id SetIamPolicyRequest properties policy $ref Policy description REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. type object SpatialPartition description Partition of asset in space. id SpatialPartition properties xMax description The maximum x coordinate value. format int64 type string xMin description The minimum x coordinate value. format int64 type string yMax description The maximum y coordinate value. format int64 type string yMin description The minimum y coordinate value. format int64 type string type object Status description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id Status properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object Stream description Message describing the Stream object. The Stream and the Event resources are many to many; i.e., each Stream resource can associate to many Event resources and each Event resource can associate to many Stream resources. id Stream properties annotations additionalProperties type string description Annotations to allow clients to store small amounts of arbitrary data. type object createTime description Output only. The create timestamp. format google-datetime readOnly True type string displayName description The display name for the stream resource. type string enableHlsPlayback description Whether to enable the HLS playback service on this stream. type boolean labels additionalProperties type string description Labels as key value pairs. type object mediaWarehouseAsset description The name of the media warehouse asset for long term storage of stream data. Format: projects/${p_id}/locations/${l_id}/corpora/${c_id}/assets/${a_id} Remain empty if the media warehouse storage is not needed for the stream. type string name description Name of the resource. type string updateTime description Output only. The update timestamp. format google-datetime readOnly True type string type object StreamAnnotation description message about annotations about Vision AI stream resource. id StreamAnnotation properties activeZone $ref NormalizedPolygon description Annotation for type ACTIVE_ZONE crossingLine $ref NormalizedPolyline description Annotation for type CROSSING_LINE displayName description User-friendly name for the annotation. type string id description ID of the annotation. It must be unique when used in the certain context. For example, all the annotations to one input streams of a Vision AI application. type string sourceStream description The Vision AI stream resource name. type string type description The actual type of Annotation. enum STREAM_ANNOTATION_TYPE_UNSPECIFIED STREAM_ANNOTATION_TYPE_ACTIVE_ZONE STREAM_ANNOTATION_TYPE_CROSSING_LINE enumDescriptions Type UNSPECIFIED. active_zone annotation defines a polygon on top of the content from an image/video based stream, following processing will only focus on the content inside the active zone. crossing_line annotation defines a polyline on top of the content from an image/video based Vision AI stream, events happening across the line will be captured. For example, the counts of people who goes acroos the line in Occupancy Analytic Processor. type string type object StreamAnnotations description A wrapper of repeated StreamAnnotation. id StreamAnnotations properties streamAnnotations description Multiple annotations. items $ref StreamAnnotation type array type object StreamInput description The inputs to this analyzer. We accept input name references of the following form: : Example: Suppose you had an operator named "SomeOp" that has 2 output arguments, the first of which is named "foo" and the second of which is named "bar", and an operator named "MyOp" that accepts 2 inputs. Also suppose that there is an analyzer named "some-analyzer" that is running "SomeOp" and another analyzer named "my-analyzer" running "MyOp". To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo" output as its first input and "some-analyzer"'s "bar" output as its second input, you can set this field to the following: input = ["some-analyzer:foo", "some-analyzer:bar"] id StreamInput properties input description The name of the stream input (as discussed above). type string type object StreamWithAnnotation description Message describing Vision AI stream with application specific annotations. All the StreamAnnotation object inside this message MUST have unique id. id StreamWithAnnotation properties applicationAnnotations description Annotations that will be applied to the whole application. items $ref StreamAnnotation type array nodeAnnotations description Annotations that will be applied to the specific node of the application. If the same type of the annotations is applied to both application and node, the node annotation will be added in addition to the global application one. For example, if there is one active zone annotation for the whole application and one active zone annotation for the Occupancy Analytic processor, then the Occupancy Analytic processor will have two active zones defined. items $ref NodeAnnotation type array stream description Vision AI Stream resource name. type string type object StringArray description A list of string-type values. id StringArray properties txtValues description String type values. items type string type array type object StructedInputAnnotation description A general annotation message that uses struct format to represent different concrete annotation protobufs. id StructedInputAnnotation properties annotation additionalProperties description Properties of the object. type any description The struct format of the actual annotation. type object ingestionTimeMicros description The ingestion time of the current annotation. format int64 type string type object StructedOutputAnnotation description A general annotation message that uses struct format to represent different concrete annotation protobufs. id StructedOutputAnnotation properties annotation additionalProperties description Properties of the object. type any description The struct format of the actual annotation. type object type object TagParsingConfig description Configuration for tag parsing. id TagParsingConfig properties entityParsingConfigs description Each tag entity class may have an optional EntityParsingConfig which is used to help parse the entities of the class. items $ref EntityParsingConfig type array type object TagRecognizerConfig description Message describing TagRecognizerConfig. id TagRecognizerConfig properties entityDetectionConfidenceThreshold description Optional. Confidence threshold to filter detection results. If not set, a system default value will be used. format float type number tagParsingConfig $ref TagParsingConfig description Optional. Configuration to customize how tags are parsed. type object TargetStreamInput description Message about target streamInput to remove. id TargetStreamInput properties stream type string type object TemporalPartition description Partition of asset in UTC Epoch time. Supported by STREAM_VIDEO corpus type. id TemporalPartition properties endTime description End time of the partition. format google-datetime type string startTime description Start time of the partition. format google-datetime type string type object TestIamPermissionsRequest description Request message for `TestIamPermissions` method. id TestIamPermissionsRequest properties permissions description The 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 type string type array type object TestIamPermissionsResponse description Response message for `TestIamPermissions` method. id TestIamPermissionsResponse properties permissions description A subset of `TestPermissionsRequest.permissions` that the caller is allowed. items type string type array type object TimeIndexedUri description Signed uri with corresponding time range. id TimeIndexedUri properties temporalPartition $ref TemporalPartition description Time range of the video that the uri is for. uri description Signed uri to download the video clip. type string type object TimeZone description Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). id TimeZone properties id description IANA Time Zone Database time zone, e.g. "America/New_York". type string version description Optional. IANA Time Zone Database version number, e.g. "2019a". type string type object UndeployApplicationRequest description Message for undeploying an Application. id UndeployApplicationRequest properties requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). type string type object UndeployApplicationResponse description Message for UndeployApplication Response. id UndeployApplicationResponse properties type object UndeployIndexMetadata description Metadata message for UndeployIndex. id UndeployIndexMetadata properties deployedIndex description Output only. The index being undeployed. readOnly True type string operationMetadata $ref OperationMetadata description Common metadata of the long-running operation. type object UndeployIndexRequest description Request message for UndeployIndexEndpoint. id UndeployIndexRequest properties type object UndeployIndexResponse description UndeployIndex response once the operation is done. id UndeployIndexResponse properties type object UndeployRetailProductRecognitionIndexRequest description Message for undeploying RetailProductRecognitionIndex from the given RetailEndpoint. id UndeployRetailProductRecognitionIndexRequest properties type object UndeployRetailProductRecognitionIndexResponse description Message for UndeployRetailProductRecognitionIndex response. id UndeployRetailProductRecognitionIndexResponse properties type object UniversalInputConfig description Message describing UniversalInputConfig. id UniversalInputConfig properties type object UpdateApplicationInstance id UpdateApplicationInstance properties instance $ref Instance description Required. The resource being updated. instanceId description Required. The id of the instance. type string updateMask description Optional. Field mask is used to specify the fields to be overwritten in the Draft resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. format google-fieldmask type string type object UpdateApplicationInstancesRequest description Message for updating an ApplicationInstance. id UpdateApplicationInstancesRequest properties allowMissing description If true, Update Request will create one resource if the target resource doesn't exist, this time, the field_mask will be ignored. type boolean applicationInstances items $ref UpdateApplicationInstance type array requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). type string type object UpdateApplicationInstancesResponse description Message for UpdateApplicationInstances Response. id UpdateApplicationInstancesResponse properties type object UpdateApplicationStreamInputRequest description Message for updating stream input to an Application. id UpdateApplicationStreamInputRequest properties allowMissing description If true, UpdateApplicationStreamInput will insert stream input to application even if the target stream is not included in the application. type boolean applicationStreamInputs description The stream inputs to update, the stream resource name is the key of each StreamInput, and it must be unique within each application. items $ref ApplicationStreamInput type array requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). type string type object UpdateApplicationStreamInputResponse description Message for AddApplicationStreamInput Response. id UpdateApplicationStreamInputResponse properties type object UpdateIndexEndpointMetadata description Metadata message for UpdateIndexEndpoint. id UpdateIndexEndpointMetadata properties operationMetadata $ref OperationMetadata description Common metadata of the long-running operation. type object UpdateIndexMetadata description Metadata message for UpdateIndexRequest id UpdateIndexMetadata properties operationMetadata $ref OperationMetadata description Common metadata of the long-running operation. type object UploadAssetMetadata description Metadata for UploadAsset. id UploadAssetMetadata properties startTime description The start time of the operation. format google-datetime type string updateTime description The update time of the operation. format google-datetime type string type object UploadAssetRequest description Request message for UploadAsset. id UploadAssetRequest properties assetSource $ref AssetSource description The source of the asset. type object UploadAssetResponse description Response message for UploadAsset. id UploadAssetResponse properties type object UserSpecifiedAnnotation description Annotation provided by users. id UserSpecifiedAnnotation properties key description Required. Key of the annotation. The key must be set with type by CreateDataSchema. type string partition $ref Partition description Partition information in time and space for the sub-asset level annotation. value $ref AnnotationValue description Value of the annotation. The value must be able to convert to the type according to the data schema. type object VertexAutoMLVideoConfig description Message describing VertexAutoMLVideoConfig. id VertexAutoMLVideoConfig properties blockedLabels description Labels specified in this field won't be returned. items type string type array boundingBoxSizeLimit description Only Bounding Box whose size is larger than this limit will be returned. Object Tracking only. Value 0.0 means to return all the detected entities. format float type number confidenceThreshold description Only entities with higher score than the threshold will be returned. Value 0.0 means returns all the detected entities. format float type number maxPredictions description At most this many predictions will be returned per output frame. Value 0 means to return all the detected entities. format int32 type integer type object VertexAutoMLVisionConfig description Message of configurations of Vertex AutoML Vision Processors. id VertexAutoMLVisionConfig properties confidenceThreshold description Only entities with higher score than the threshold will be returned. Value 0.0 means to return all the detected entities. format float type number maxPredictions description At most this many predictions will be returned per output frame. Value 0 means to return all the detected entities. format int32 type integer type object VertexCustomConfig description Message describing VertexCustomConfig. id VertexCustomConfig properties attachApplicationMetadata description If true, the prediction request received by custom model will also contain metadata with the following schema: 'appPlatformMetadata': { 'ingestionTime': DOUBLE; (UNIX timestamp) 'application': STRING; 'instanceId': STRING; 'node': STRING; 'processor': STRING; } type boolean dedicatedResources $ref DedicatedResources description A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. dynamicConfigInputTopic description Optional. By setting the configuration_input_topic, processor will subscribe to given topic, only pub/sub topic is supported now. Example channel: //pubsub.googleapis.com/projects/visionai-testing-stable/topics/test-topic message schema should be: message Message { // The ID of the stream that associates with the application instance. string stream_id = 1; // The target fps. By default, the custom processor will *not* send any data to the Vertex Prediction container. Note that once the dynamic_config_input_topic is set, max_prediction_fps will not work and be preceded by the fps set inside the topic. int32 fps = 2; } type string maxPredictionFps description The max prediction frame per second. This attribute sets how fast the operator sends prediction requests to Vertex AI endpoint. Default value is 0, which means there is no max prediction fps limit. The operator sends prediction requests at input fps. format int32 type integer postProcessingCloudFunction description If not empty, the prediction result will be sent to the specified cloud function for post processing. * The cloud function will receive AppPlatformCloudFunctionRequest where the annotations field will be the json format of proto PredictResponse. * The cloud function should return AppPlatformCloudFunctionResponse with PredictResponse stored in the annotations field. * To drop the prediction output, simply clear the payload field in the returned AppPlatformCloudFunctionResponse. type string type object VideoActionRecognitionPredictionResult description Prediction output format for Video Action Recognition. id VideoActionRecognitionPredictionResult properties actions description All of the actions identified in the time range. items $ref IdentifiedAction type array segmentEndTime description The end, inclusive, of the video's time segment in which the actions have been identified. Particularly, if the end is the same as the start, it means the identification happens on a specific video frame. format google-datetime type string segmentStartTime description The beginning, inclusive, of the video's time segment in which the actions have been identified. format google-datetime type string type object VideoClassificationPredictionResult description Prediction output format for Video Classification. id VideoClassificationPredictionResult properties classifications description All of the classifications identified in the time range. items $ref IdentifiedClassification type array segmentEndTime description The end, inclusive, of the video's time segment in which the classifications have been identified. Particularly, if the end is the same as the start, it means the identification happens on a specific video frame. format google-datetime type string segmentStartTime description The beginning, inclusive, of the video's time segment in which the classifications have been identified. format google-datetime type string type object VideoObjectTrackingPredictionResult description Prediction output format for Video Object Tracking. id VideoObjectTrackingPredictionResult properties objects description All of the objects detected in the specified time range. items $ref DetectedObject type array segmentEndTime description The end, inclusive, of the video's time segment in which the current identifications happen. Particularly, if the end is the same as the start, it means the identifications happen on a specific video frame. format google-datetime type string segmentStartTime description The beginning, inclusive, of the video's time segment in which the current identifications happens. format google-datetime type string type object VideoStreamInputConfig description Message describing Video Stream Input Config. This message should only be used as a placeholder for builtin:stream-input processor, actual stream binding should be specified using corresponding API. id VideoStreamInputConfig properties streams deprecated True items type string type array streamsWithAnnotation deprecated True items $ref StreamWithAnnotation type array type object ViewCollectionItemsResponse description Response message for ViewCollectionItems. id ViewCollectionItemsResponse properties items description The items from the specified collection. items $ref CollectionItem type array nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string type object ViewIndexedAssetsResponse description Response message for ViewIndexedAssets. id ViewIndexedAssetsResponse properties indexedAssets description The assets from the specified index. items $ref IndexedAsset type array nextPageToken description A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type string type object WatchEventsRequest description WatchEventsRequest contains the information of the watcher identification and the filters of the events the watcher is interested in. id WatchEventsRequest properties eventUpdateFilter $ref EventUpdateFilter description The filter that the watchers can speficy on which event updates that they want to receive. heartbeatIntervalSecond description HeartbeatIntervalSecond defines the interval (in second) of heartbeat response returned from the gRPC streaming server. Default 0 means no heartbeat will be returned. format float type number streams description The name of the stream or the set of streams to watch. items type string type array watcherId description Unique ID identifies the watcher of the streams. type string type object WatchEventsResponse description Each response message will contain one Event update. id WatchEventsResponse properties event description The name of the event. type string series description The name of the series. type string stream description The name of the stream that the event is attached to. type string updateTime description The timestamp when the Event update happens. format google-datetime type string updateType description The type of the Event update. enum EVENT_UPDATE_TYPE_UNSPECIFIED EVENT_AVAILABLE_ON_STREAM EVENT_HEARTBEAT enumDescriptions Event update type unspecified. Event is available to read from on a stream. Heartbeat message that is used to track liveliness of the gRPC connection. type string type object servicePath title Vision AI API version v1alpha1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/voltr-pa-	values_changed root['revision'] new_value 20250205 old_value 20250129
prod/voltr-pa-v1	values_changed root['revision'] new_value 20250205 old_value 20250129
prod/walletobjects-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/walletobjects-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/webrisk-	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/webrisk-v1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/webrisk-v1beta1	values_changed root['revision'] new_value 20250202 old_value 20250126
prod/workflows-v1	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/workflows-v1alpha1	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/workflows-v1beta	values_changed root['revision'] new_value 20250129 old_value 20250122
prod/workloadcertificate-v1alpha1	values_changed root new_value auth oauth2 scopes https://www.googleapis.com/auth/cloud-platform description See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. basePath baseUrl https://workloadcertificate.googleapis.com/ batchPath batch canonicalName Workload Certificate description workloadcertificate.googleapis.com API. discoveryVersion v1 documentationLink https://cloud.google.com/ fullyEncodeReservedExpansion True icons x16 http://www.google.com/images/icons/product/search-16.gif x32 http://www.google.com/images/icons/product/search-32.gif id workloadcertificate:v1alpha1 kind discovery#restDescription mtlsRootUrl https://workloadcertificate.mtls.googleapis.com/ name workloadcertificate ownerDomain google.com ownerName Google parameters $.xgafv description V1 error format. enum 1 2 enumDescriptions v1 error format v2 error format location query type string access_token description OAuth access token. location query type string alt default json description Data 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 location query type string callback description JSONP location query type string fields description Selector specifying which fields to include in a partial response. location query type string key description API 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. location query type string oauth_token description OAuth 2.0 token for the current user. location query type string prettyPrint default true description Returns response with indentations and line breaks. location query type boolean quotaUser description Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. location query type string uploadType description Legacy upload protocol for media (e.g. "media", "multipart"). location query type string upload_protocol description Upload protocol for media (e.g. "raw", "multipart"). location query type string protocol rest resources projects resources locations methods get description Gets information about a location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId} httpMethod GET id workloadcertificate.projects.locations.get parameterOrder name parameters name description Resource name for the location. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Location scopes https://www.googleapis.com/auth/cloud-platform list description Lists information about the supported locations for this service. flatPath v1alpha1/projects/{projectsId}/locations httpMethod GET id workloadcertificate.projects.locations.list parameterOrder name parameters filter description A 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). location query type string name description The resource that owns the locations collection, if applicable. location path pattern ^projects/[^/]+$ required True type string pageSize description The maximum number of results to return. If not set, the service selects a default. format int32 location query type integer pageToken description A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. location query type string path v1alpha1/{+name}/locations response $ref ListLocationsResponse scopes https://www.googleapis.com/auth/cloud-platform resources global methods getWorkloadCertificateFeature description Gets the `WorkloadCertificateFeature` resource of a given project. `WorkloadCertificateFeature` is a singleton resource. flatPath v1alpha1/projects/{projectsId}/locations/global/workloadCertificateFeature httpMethod GET id workloadcertificate.projects.locations.global.getWorkloadCertificateFeature parameterOrder name parameters name description Required. Name of the `WorkloadCertificateFeature` resource. Format: `projects/{project ID or number}/locations/global/workloadCertificateFeature`. location path pattern ^projects/[^/]+/locations/global/workloadCertificateFeature$ required True type string path v1alpha1/{+name} response $ref WorkloadCertificateFeature scopes https://www.googleapis.com/auth/cloud-platform updateWorkloadCertificateFeature description Updates the `WorkloadCertificateFeature` resource of a given project. flatPath v1alpha1/projects/{projectsId}/locations/global/workloadCertificateFeature httpMethod PATCH id workloadcertificate.projects.locations.global.updateWorkloadCertificateFeature parameterOrder name parameters force description Force WorkloadCertificateFeature disablement. All WorkloadRegistrations in the same fleet will be deleted. location query type boolean name description Required. Name of the `WorkloadCertificateFeature` resource to update. Format: `projects/{project ID or number}/locations/global/workloadCertificateFeature`. location path pattern ^projects/[^/]+/locations/global/workloadCertificateFeature$ required True type string path v1alpha1/{+name} request $ref WorkloadCertificateFeature response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform operations methods cancel description Starts 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`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel httpMethod POST id workloadcertificate.projects.locations.operations.cancel parameterOrder name parameters name description The name of the operation resource to be cancelled. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name}:cancel request $ref CancelOperationRequest response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes 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`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod DELETE id workloadcertificate.projects.locations.operations.delete parameterOrder name parameters name description The name of the operation resource to be deleted. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Empty scopes https://www.googleapis.com/auth/cloud-platform get description Gets 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. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId} httpMethod GET id workloadcertificate.projects.locations.operations.get parameterOrder name parameters name description The name of the operation resource. location path pattern ^projects/[^/]+/locations/[^/]+/operations/[^/]+$ required True type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform list description Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/operations httpMethod GET id workloadcertificate.projects.locations.operations.list parameterOrder name parameters filter description The standard list filter. location query type string name description The name of the operation's parent resource. location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string pageSize description The standard list page size. format int32 location query type integer pageToken description The standard list page token. location query type string path v1alpha1/{+name}/operations response $ref ListOperationsResponse scopes https://www.googleapis.com/auth/cloud-platform workloadRegistrations methods create description Creates a new WorkloadRegistration in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/workloadRegistrations httpMethod POST id workloadcertificate.projects.locations.workloadRegistrations.create parameterOrder parent parameters parent description Required. Value for parent. Format: `projects/{project ID or number}/locations/{location}` location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string workloadRegistrationId description Required. Client defined WorkloadRegistration name. This can be any unique string that matches the regex ^[a-zA-Z0-9-._~%!$&'()*+,;=@]{1,63}$. location query type string path v1alpha1/{+parent}/workloadRegistrations request $ref WorkloadRegistration response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform delete description Deletes a single WorkloadRegistration. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/workloadRegistrations/{workloadRegistrationsId} httpMethod DELETE id workloadcertificate.projects.locations.workloadRegistrations.delete parameterOrder name parameters name description Required. Name of the resource. Format: `projects/{project ID or number}/locations/{location}/workloadRegistrations/{workload_registration_id}` location path pattern ^projects/[^/]+/locations/[^/]+/workloadRegistrations/[^/]+$ required True type string requestId description Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). location query type string path v1alpha1/{+name} response $ref Operation scopes https://www.googleapis.com/auth/cloud-platform get description Gets details of a single WorkloadRegistration. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/workloadRegistrations/{workloadRegistrationsId} httpMethod GET id workloadcertificate.projects.locations.workloadRegistrations.get parameterOrder name parameters name description Required. Name of the resource. Format: `projects/{project ID or number}/locations/{location}/workloadRegistrations/{workload_registration_id}` location path pattern ^projects/[^/]+/locations/[^/]+/workloadRegistrations/[^/]+$ required True type string path v1alpha1/{+name} response $ref WorkloadRegistration scopes https://www.googleapis.com/auth/cloud-platform list description Lists WorkloadRegistrations in a given project and location. flatPath v1alpha1/projects/{projectsId}/locations/{locationsId}/workloadRegistrations httpMethod GET id workloadcertificate.projects.locations.workloadRegistrations.list parameterOrder parent parameters filter description Filtering results. See https://google.aip.dev/160. location query type string orderBy description Hint for how to order the results. See https://google.aip.dev/132#ordering. Currently, only ordering by name and create_time are supported. location query type string pageSize description Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. format int32 location query type integer pageToken description The next_page_token value returned from a previous List request, if any. location query type string parent description Required. Parent value for ListWorkloadRegistrationsRequest. Format: `projects/{project ID or number}/locations/{location}` location path pattern ^projects/[^/]+/locations/[^/]+$ required True type string path v1alpha1/{+parent}/workloadRegistrations response $ref ListWorkloadRegistrationsResponse scopes https://www.googleapis.com/auth/cloud-platform revision 20240117 rootUrl https://workloadcertificate.googleapis.com/ schemas CaPoolsStatus description Status of CA pools in a region. id CaPoolsStatus properties caPools description The CA pool string has a relative resource path following the form "projects/{project number}/locations/{location}/caPools/{CA pool}". items type string type array type object CancelOperationRequest description The request message for Operations.CancelOperation. id CancelOperationRequest properties type object Empty description A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } id Empty properties type object K8SWorkloadSelector description For Kubernetes workloads, fleet_member_id is used as workload selector. id K8SWorkloadSelector properties fleetMemberId description Required. Fleet membership ID (only the name part, not the full URI). The project and location of the membership are the same as the WorkloadRegistration. type string type object ListLocationsResponse description The response message for Locations.ListLocations. id ListLocationsResponse properties locations description A list of locations that matches the specified filter in the request. items $ref Location type array nextPageToken description The standard List next-page token. type string type object ListOperationsResponse description The response message for Operations.ListOperations. id ListOperationsResponse properties nextPageToken description The standard List next-page token. type string operations description A list of operations that matches the specified filter in the request. items $ref Operation type array type object ListWorkloadRegistrationsResponse description Response message for listing WorkloadRegistrations. id ListWorkloadRegistrationsResponse properties nextPageToken description A token identifying a page of results the server should return for the next List request. Empty if this response is the last page. type string unreachable description Locations that could not be reached. items type string type array workloadRegistrations description The list of WorkloadRegistrations. items $ref WorkloadRegistration type array type object Location description A resource that represents a Google Cloud location. id Location properties displayName description The friendly name for this location, typically a nearby city name. For example, "Tokyo". type string labels additionalProperties type string description Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} type object locationId description The canonical id for this location. For example: `"us-east1"`. type string metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-specific metadata. For example the available capacity at the given location. type object name description Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` type string type object Operation description This resource represents a long-running operation that is the result of a network API call. id Operation properties done description If 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. type boolean error $ref Status description The error result of the operation in case of failure or cancellation. metadata additionalProperties description Properties of the object. Contains field @type with type URL. type any description Service-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. type object name description The 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}`. type string response additionalProperties description Properties of the object. Contains field @type with type URL. type any description The 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`. type object type object OperationMetadata description Represents the metadata of the long-running operation. id OperationMetadata properties apiVersion description Output only. API version used to start the operation. readOnly True type string createTime description Output only. The time the operation was created. format google-datetime readOnly True type string endTime description Output only. The time the operation finished running. format google-datetime readOnly True type string requestedCancellation description Output only. Identifies whether the user has requested cancellation of the operation. Currently we don't support cancelling any operation. Consider applying the opposite mutation after the current operation is done. For example, call DeleteWorkloadRegistration afterwards if you want to cancel a CreateWorkloadRegistration operation. readOnly True type boolean statusMessage description Output only. Human-readable status of the operation, if any. readOnly True type string target description Output only. Server-defined resource path for the target of the operation. readOnly True type string verb description Output only. Name of the verb executed by the operation. readOnly True type string type object RegistrationStatus description RegistrationStatus describes the certificate provisioning status of a WorkloadRegistration resource. id RegistrationStatus properties state description The current state of registration. enum REGISTRATION_STATE_UNSPECIFIED REGISTRATION_STATE_READY REGISTRATION_STATE_IN_PROGRESS REGISTRATION_STATE_INTERNAL_ERROR enumDescriptions REGISTRATION_STATE_UNSPECIFIED is the default value. REGISTRATION_STATE_READY indicates that the registration is ready. REGISTRATION_STATE_IN_PROGRESS indicates that the registration is in progress. REGISTRATION_STATE_INTERNAL_ERROR indicates that the registration has encountered some internal errors but is retrying. Contact support if this persists. type string type object Status description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). id Status properties code description The status code, which should be an enum value of google.rpc.Code. format int32 type integer details description A list of messages that carry the error details. There is a common set of message types for APIs to use. items additionalProperties description Properties of the object. Contains field @type with type URL. type any type object type array message description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type string type object WorkloadCertificateFeature description Represents the Managed Workload Certificate feature. This is a singleton resource of a project that contains the mode of the feature, trust-domain-level configurations, and etc. id WorkloadCertificateFeature properties defaultSpec $ref WorkloadCertificateFeatureSpec description Required. Workload certificate feature spec for the default project level trust domain (i.e. `{project ID}.svc.id.goog`). defaultStatus $ref WorkloadCertificateFeatureStatus description Output only. The current WorkloadCertificate feature status of the default project level trust domain. readOnly True name description Output only. Name of the resource. Format: `projects/{project ID or number}/locations/global/workloadCertificateFeature`. readOnly True type string type object WorkloadCertificateFeatureSpec description Spec for the workload certificate feature. id WorkloadCertificateFeatureSpec properties mode description Required. The mode for the workload certificate feature. enum MODE_UNSPECIFIED MODE_DISABLED MODE_ENABLED_WITH_MANAGED_CA MODE_ENABLED_WITH_DEFAULT_CA enumDescriptions Do not use this value. Workload certificate feature is disabled. Workload certificate feature is enabled, and the entire certificate provisioning process is managed by Google with managed CAS more secure than the free-tier CAS. Workload certificate feature is enabled, and the entire certificate provisioning process is using the default CA with managed CAS in default version which is free. type string type object WorkloadCertificateFeatureStatus description Status of Workload Certificate feature at trust domain level. id WorkloadCertificateFeatureStatus properties managedCaPools additionalProperties $ref CaPoolsStatus description A map from a region to the status of managed CA pools in that region. type object state description Describes whether the Workload Certificate feature meets its spec. enum FEATURE_STATE_UNSPECIFIED FEATURE_STATE_IN_PROGRESS FEATURE_STATE_READY FEATURE_STATE_INTERNAL_ERROR enumDescriptions The feature status does not fully meet its spec at the moment but is trying to meet its spec. The feature status does not fully meet its spec at the moment but is trying to meet its spec. The feature status currently meets its spec. The feature status does not fully meet its spec at the moment due to an internal error but the backend is retrying. Contact support if this persists. type string type object WorkloadRegistration description Message describing WorkloadRegistration object id WorkloadRegistration properties createTime description Output only. Time when this WorkloadRegistration resource was created. format google-datetime readOnly True type string name description Output only. Name of this WorkloadRegistration resource. Format: `projects/{project ID or number}/locations/{location} /workloadRegistrations/{client-defined workload_registration_id}` {location} is Fleet membership location for GKE clusters and this is subject to change. readOnly True type string status $ref RegistrationStatus description Output only. The status of the WorkloadRegistration resource. readOnly True updateTime description Output only. Time when this WorkloadRegistration resource was most recently updated. format google-datetime readOnly True type string workloadSelector $ref WorkloadSelector description Required. Selects the workloads in the registration. type object WorkloadSelector description WorkloadSelector specifies the criteria used to determine if a workload is in a WorkloadRegistration. Different workload types have their own matching criteria. id WorkloadSelector properties k8sWorkloadSelector $ref K8SWorkloadSelector description Selects K8S workloads. type object servicePath title Workload Certificate API version v1alpha1 version_module True old_value error code 403 message Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API. status PERMISSION_DENIED
prod/workloadmanager-	dictionary_item_added root['schemas']['Database']['properties']['diskType'] root['schemas']['SqlServerWorkload']['properties']['computeEngineServiceAccount'] values_changed root['revision'] new_value 20250129 old_value 20250120
prod/workloadmanager-v1alpha	dictionary_item_added root['schemas']['Database']['properties']['diskType'] root['schemas']['SqlServerWorkload']['properties']['computeEngineServiceAccount'] values_changed root['revision'] new_value 20250129 old_value 20250120
prod/workspaceevents-v1	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/workspaceevents-v1beta	values_changed root['revision'] new_value 20250204 old_value 20250128
prod/workstations-v1alpha	values_changed root['revision'] new_value 20250113 old_value 20250122
prod/workstations-v1beta	dictionary_item_removed root['schemas']['Workstation']['properties']['conditions'] root['schemas']['Workstation']['properties']['degraded'] values_changed root['revision'] new_value 20250113 old_value 20250122
prod/youtube-	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/youtube-v1	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/youtube-v3	values_changed root['revision'] new_value 20250206 old_value 20250205
prod/youtubeanalytics-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/youtubeanalytics-v1	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/youtubeanalytics-v2	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/youtubeembeddedplayer-	dictionary_item_added root['schemas']['GoogleYoutubeEmbeddedplayerV1beta1VerifyHostAppRequest']['properties']['remoteIp'] values_changed root['revision'] new_value 20250205 old_value 20250129 root['schemas']['GoogleYoutubeEmbeddedplayerV1beta1VerifyHostAppRequest']['description'] new_value Request message for YouTubeWatchEmbeddedPlayerService.VerifyHostApp. NEXT ID: 29 old_value Request message for YouTubeWatchEmbeddedPlayerService.VerifyHostApp. NEXT ID: 28
prod/youtubeembeddedplayer-v1beta1	dictionary_item_added root['schemas']['GoogleYoutubeEmbeddedplayerV1beta1VerifyHostAppRequest']['properties']['remoteIp'] values_changed root['revision'] new_value 20250205 old_value 20250129 root['schemas']['GoogleYoutubeEmbeddedplayerV1beta1VerifyHostAppRequest']['description'] new_value Request message for YouTubeWatchEmbeddedPlayerService.VerifyHostApp. NEXT ID: 29 old_value Request message for YouTubeWatchEmbeddedPlayerService.VerifyHostApp. NEXT ID: 28
prod/youtubeoembed-	values_changed root['revision'] new_value 20250205 old_value 20250129
prod/youtubeoembed-v1	values_changed root['revision'] new_value 20250205 old_value 20250129
prod/youtubereporting-	values_changed root['revision'] new_value 20250205 old_value 20250204
prod/youtubereporting-v1	values_changed root['revision'] new_value 20250205 old_value 20250204