list_next(previous_request, previous_response)
Retrieves the next page of results.
+
+ partialUpdateCluster(name, body=None, updateMask=None, x__xgafv=None)
Partially updates a cluster within a project. This method is the preferred way to update a Cluster.
update(name, body=None, x__xgafv=None)
Updates a cluster within an instance.
+Updates a cluster within an instance. UpdateCluster is deprecated. Please use PartialUpdateCluster instead.
close()
@@ -249,9 +252,59 @@ partialUpdateCluster(name, body=None, updateMask=None, x__xgafv=None)
+ Partially updates a cluster within a project. This method is the preferred way to update a Cluster.
+
+Args:
+ name: string, The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.
+ "defaultStorageType": "A String", # Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
+ "encryptionConfig": { # Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. # Immutable. The encryption configuration for CMEK-protected clusters.
+ "kmsKeyName": "A String", # Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster. 3) All clusters within an instance must use the same CMEK key. Values are of the form `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
+ },
+ "location": "A String", # Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`.
+ "name": "A String", # The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.
+ "serveNodes": 42, # Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
+ "state": "A String", # Output only. The current state of the cluster.
+}
+
+ updateMask: string, Required. The subset of Cluster fields which should be replaced. Must be explicitly set.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # 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.
+ "error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # 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}`.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+update(name, body=None, x__xgafv=None)
- Updates a cluster within an instance.
+ Updates a cluster within an instance. UpdateCluster is deprecated. Please use PartialUpdateCluster instead.
Args:
name: string, The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. (required)
diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
index 170fa952e03..eb8aaf2fd22 100644
--- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
+++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
@@ -359,7 +359,7 @@ Method Details
NAME_ONLY - Only populates `name`.
SCHEMA_VIEW - Only populates `name` and fields related to the table's schema.
REPLICATION_VIEW - Only populates `name` and fields related to the table's replication state.
- ENCRYPTION_VIEW - Only populates 'name' and fields related to the table's encryption state.
+ ENCRYPTION_VIEW - Only populates `name` and fields related to the table's encryption state.
FULL - Populates all fields.
x__xgafv: string, V1 error format.
Allowed values
@@ -492,7 +492,7 @@ Method Details
NAME_ONLY - Only populates `name`.
SCHEMA_VIEW - Only populates `name` and fields related to the table's schema.
REPLICATION_VIEW - Only populates `name` and fields related to the table's replication state.
- ENCRYPTION_VIEW - Only populates 'name' and fields related to the table's encryption state.
+ ENCRYPTION_VIEW - Only populates `name` and fields related to the table's encryption state.
FULL - Populates all fields.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/cloudscheduler_v1.projects.locations.html b/docs/dyn/cloudscheduler_v1.projects.locations.html
index 6aaa7a3513c..57c0e13ed4c 100644
--- a/docs/dyn/cloudscheduler_v1.projects.locations.html
+++ b/docs/dyn/cloudscheduler_v1.projects.locations.html
@@ -131,7 +131,7 @@ Method Details
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
filter: string, 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).
- pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+ pageSize: integer, The maximum number of results to return. If not set, the service will select a default.
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/cloudscheduler_v1beta1.projects.locations.html b/docs/dyn/cloudscheduler_v1beta1.projects.locations.html
index ef53d75674f..6bc70ec05b6 100644
--- a/docs/dyn/cloudscheduler_v1beta1.projects.locations.html
+++ b/docs/dyn/cloudscheduler_v1beta1.projects.locations.html
@@ -131,7 +131,7 @@ Method Details
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
filter: string, 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).
- pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+ pageSize: integer, The maximum number of results to return. If not set, the service will select a default.
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/composer_v1beta1.projects.locations.environments.html b/docs/dyn/composer_v1beta1.projects.locations.environments.html
index c518b0b095b..3f6a47ba0dc 100644
--- a/docs/dyn/composer_v1beta1.projects.locations.environments.html
+++ b/docs/dyn/composer_v1beta1.projects.locations.environments.html
@@ -120,7 +120,7 @@ Method Details
"databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow software. # Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
"machineType": "A String", # Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
},
- "encryptionConfig": { # The encryption options for the Composer environment and its dependencies. # Optional. The encryption options for the Composer environment and its dependencies. Cannot be updated.
+ "encryptionConfig": { # The encryption options for the Cloud Composer environment and its dependencies. # Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
"kmsKeyName": "A String", # Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used.
},
"gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.
@@ -145,7 +145,7 @@ Method Details
"oauthScopes": [ # Optional. The set of Google API scopes to be made available on all node VMs. If `oauth_scopes` is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.
"A String",
],
- "serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated.
+ "serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the workloads. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated .
"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, `nodeConfig.network` must also be provided, and the subnetwork must belong to the enclosing environment's project and location.
"tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated.
"A String",
@@ -154,7 +154,7 @@ Method Details
"nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
"privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer environment. # The configuration used for the Private IP Cloud Composer environment.
"cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block
- "enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true.
+ "enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true .
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer environment. # Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is denied.
"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
@@ -283,7 +283,7 @@ Method Details
"databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow software. # Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
"machineType": "A String", # Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
},
- "encryptionConfig": { # The encryption options for the Composer environment and its dependencies. # Optional. The encryption options for the Composer environment and its dependencies. Cannot be updated.
+ "encryptionConfig": { # The encryption options for the Cloud Composer environment and its dependencies. # Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
"kmsKeyName": "A String", # Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used.
},
"gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.
@@ -308,7 +308,7 @@ Method Details
"oauthScopes": [ # Optional. The set of Google API scopes to be made available on all node VMs. If `oauth_scopes` is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.
"A String",
],
- "serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated.
+ "serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the workloads. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated .
"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, `nodeConfig.network` must also be provided, and the subnetwork must belong to the enclosing environment's project and location.
"tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated.
"A String",
@@ -317,7 +317,7 @@ Method Details
"nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
"privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer environment. # The configuration used for the Private IP Cloud Composer environment.
"cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block
- "enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true.
+ "enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true .
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer environment. # Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is denied.
"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
@@ -387,7 +387,7 @@ Method Details
"databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow software. # Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
"machineType": "A String", # Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
},
- "encryptionConfig": { # The encryption options for the Composer environment and its dependencies. # Optional. The encryption options for the Composer environment and its dependencies. Cannot be updated.
+ "encryptionConfig": { # The encryption options for the Cloud Composer environment and its dependencies. # Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
"kmsKeyName": "A String", # Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used.
},
"gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.
@@ -412,7 +412,7 @@ Method Details
"oauthScopes": [ # Optional. The set of Google API scopes to be made available on all node VMs. If `oauth_scopes` is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.
"A String",
],
- "serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated.
+ "serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the workloads. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated .
"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, `nodeConfig.network` must also be provided, and the subnetwork must belong to the enclosing environment's project and location.
"tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated.
"A String",
@@ -421,7 +421,7 @@ Method Details
"nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
"privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer environment. # The configuration used for the Private IP Cloud Composer environment.
"cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block
- "enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true.
+ "enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true .
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer environment. # Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is denied.
"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
@@ -499,7 +499,7 @@ Method Details
"databaseConfig": { # The configuration of Cloud SQL instance that is used by the Apache Airflow software. # Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
"machineType": "A String", # Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
},
- "encryptionConfig": { # The encryption options for the Composer environment and its dependencies. # Optional. The encryption options for the Composer environment and its dependencies. Cannot be updated.
+ "encryptionConfig": { # The encryption options for the Cloud Composer environment and its dependencies. # Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
"kmsKeyName": "A String", # Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated. If not specified, Google-managed key will be used.
},
"gkeCluster": "A String", # Output only. The Kubernetes Engine cluster used to run this environment.
@@ -524,7 +524,7 @@ Method Details
"oauthScopes": [ # Optional. The set of Google API scopes to be made available on all node VMs. If `oauth_scopes` is empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. Cannot be updated.
"A String",
],
- "serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated.
+ "serviceAccount": "A String", # Optional. The Google Cloud Platform Service Account to be used by the workloads. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated .
"subnetwork": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications, specified as a [relative resource name](/apis/design/resource_names#relative_resource_name). For example: "projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}" If a subnetwork is provided, `nodeConfig.network` must also be provided, and the subnetwork must belong to the enclosing environment's project and location.
"tags": [ # Optional. The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Cannot be updated.
"A String",
@@ -533,7 +533,7 @@ Method Details
"nodeCount": 42, # The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
"privateEnvironmentConfig": { # The configuration information for configuring a Private IP Cloud Composer environment. # The configuration used for the Private IP Cloud Composer environment.
"cloudSqlIpv4CidrBlock": "A String", # Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block
- "enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true.
+ "enablePrivateEnvironment": True or False, # Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true .
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer environment. # Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is denied.
"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
diff --git a/docs/dyn/datastore_v1beta3.projects.html b/docs/dyn/datastore_v1beta3.projects.html
index fd4ef0b6ee4..cbd1a3b405c 100644
--- a/docs/dyn/datastore_v1beta3.projects.html
+++ b/docs/dyn/datastore_v1beta3.projects.html
@@ -232,40 +232,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"update": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to update. The entity must already exist. Must have a complete key path.
@@ -283,40 +250,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"upsert": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.
@@ -334,40 +268,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
},
@@ -480,40 +381,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
@@ -537,40 +405,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
@@ -668,7 +503,24 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
+ "a_key": # Object with schema name: Value
+ },
+ },
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
@@ -707,7 +559,24 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
+ "a_key": # Object with schema name: Value
+ },
+ },
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
@@ -768,7 +637,24 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
+ "a_key": # Object with schema name: Value
+ },
+ },
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
@@ -855,40 +741,7 @@ Method Details
],
},
"properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
- "a_key": { # A message that can hold any of the supported value types and associated metadata.
- "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`.
- "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
- # Object with schema name: Value
- ],
- },
- "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
- "booleanValue": True or False, # A boolean value.
- "doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
- "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
- "geoPointValue": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
- "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
- "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
- },
- "integerValue": "A String", # An integer value.
- "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value.
- "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
- "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
- "projectId": "A String", # The ID of the project to which the entities belong.
- },
- "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
- { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
- "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
- "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
- },
- ],
- },
- "meaning": 42, # The `meaning` field should only be populated for backwards compatibility.
- "nullValue": "A String", # A null value.
- "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
- "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
- },
+ "a_key": # Object with schema name: Value
},
},
"version": "A String", # The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
@@ -927,7 +780,24 @@ Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
"booleanValue": True or False, # A boolean value.
"doubleValue": 3.14, # A double value.
- "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key.
+ "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
+ "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
+ "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong.
+ "projectId": "A String", # The ID of the project to which the entities belong.
+ },
+ "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
+ { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
+ "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
+ "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`.
+ },
+ ],
+ },
+ "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`.
+ "a_key": # Object with schema name: Value
+ },
+ },
"excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly.
"geoPointValue": { # 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 must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth.
"latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
diff --git a/docs/dyn/firestore_v1.projects.locations.html b/docs/dyn/firestore_v1.projects.locations.html
index 4b4947faf05..f4c0f0c471e 100644
--- a/docs/dyn/firestore_v1.projects.locations.html
+++ b/docs/dyn/firestore_v1.projects.locations.html
@@ -126,7 +126,7 @@ Method Details
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
filter: string, 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).
- pageSize: integer, The maximum number of results to return. If not set, the service will select a default.
+ pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/redis_v1.projects.locations.html b/docs/dyn/redis_v1.projects.locations.html
index 5287c0af80a..78a365aa164 100644
--- a/docs/dyn/redis_v1.projects.locations.html
+++ b/docs/dyn/redis_v1.projects.locations.html
@@ -136,7 +136,7 @@ Method Details
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
filter: string, 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).
- pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+ pageSize: integer, The maximum number of results to return. If not set, the service will select a default.
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/redis_v1beta1.projects.locations.html b/docs/dyn/redis_v1beta1.projects.locations.html
index 36109f98044..830c1675703 100644
--- a/docs/dyn/redis_v1beta1.projects.locations.html
+++ b/docs/dyn/redis_v1beta1.projects.locations.html
@@ -136,7 +136,7 @@ Method Details
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
filter: string, 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).
- pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+ pageSize: integer, The maximum number of results to return. If not set, the service will select a default.
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html
index 6f2bbf8151d..76afdc3db1c 100644
--- a/docs/dyn/sqladmin_v1beta4.instances.html
+++ b/docs/dyn/sqladmin_v1beta4.instances.html
@@ -798,10 +798,6 @@ Method Details
"password": "A String", # The password for connecting to on-premises instance.
"username": "A String", # The username for connecting to on-premises instance.
},
- "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job
- "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend
- "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job
- },
"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.
"replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
@@ -1099,10 +1095,6 @@ Method Details
"password": "A String", # The password for connecting to on-premises instance.
"username": "A String", # The username for connecting to on-premises instance.
},
- "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job
- "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend
- "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job
- },
"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.
"replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
@@ -1376,10 +1368,6 @@ Method Details
"password": "A String", # The password for connecting to on-premises instance.
"username": "A String", # The username for connecting to on-premises instance.
},
- "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job
- "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend
- "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job
- },
"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.
"replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
@@ -1625,10 +1613,6 @@ Method Details
"password": "A String", # The password for connecting to on-premises instance.
"username": "A String", # The username for connecting to on-premises instance.
},
- "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job
- "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend
- "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job
- },
"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.
"replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
@@ -2613,10 +2597,6 @@ Method Details
"password": "A String", # The password for connecting to on-premises instance.
"username": "A String", # The username for connecting to on-premises instance.
},
- "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # This field represents the report generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job
- "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend
- "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job
- },
"project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
"region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.
"replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json
index aa6bd1a9afb..eb801f96b49 100644
--- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json
@@ -116,10 +116,10 @@
"parameters": {},
"path": "v1beta1/alerts:batchDelete",
"request": {
- "$ref": "GoogleAppsAlertcenterV1beta1BatchDeleteAlertsRequest"
+ "$ref": "BatchDeleteAlertsRequest"
},
"response": {
- "$ref": "GoogleAppsAlertcenterV1beta1BatchDeleteAlertsResponse"
+ "$ref": "BatchDeleteAlertsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
@@ -134,10 +134,10 @@
"parameters": {},
"path": "v1beta1/alerts:batchUndelete",
"request": {
- "$ref": "GoogleAppsAlertcenterV1beta1BatchUndeleteAlertsRequest"
+ "$ref": "BatchUndeleteAlertsRequest"
},
"response": {
- "$ref": "GoogleAppsAlertcenterV1beta1BatchUndeleteAlertsResponse"
+ "$ref": "BatchUndeleteAlertsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
@@ -166,7 +166,7 @@
},
"path": "v1beta1/alerts/{alertId}",
"response": {
- "$ref": "GoogleProtobufEmpty"
+ "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
@@ -195,7 +195,7 @@
},
"path": "v1beta1/alerts/{alertId}",
"response": {
- "$ref": "GoogleAppsAlertcenterV1beta1Alert"
+ "$ref": "Alert"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
@@ -224,7 +224,7 @@
},
"path": "v1beta1/alerts/{alertId}/metadata",
"response": {
- "$ref": "GoogleAppsAlertcenterV1beta1AlertMetadata"
+ "$ref": "AlertMetadata"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
@@ -266,7 +266,7 @@
},
"path": "v1beta1/alerts",
"response": {
- "$ref": "GoogleAppsAlertcenterV1beta1ListAlertsResponse"
+ "$ref": "ListAlertsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
@@ -290,10 +290,10 @@
},
"path": "v1beta1/alerts/{alertId}:undelete",
"request": {
- "$ref": "GoogleAppsAlertcenterV1beta1UndeleteAlertRequest"
+ "$ref": "UndeleteAlertRequest"
},
"response": {
- "$ref": "GoogleAppsAlertcenterV1beta1Alert"
+ "$ref": "Alert"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
@@ -326,10 +326,10 @@
},
"path": "v1beta1/alerts/{alertId}/feedback",
"request": {
- "$ref": "GoogleAppsAlertcenterV1beta1AlertFeedback"
+ "$ref": "AlertFeedback"
},
"response": {
- "$ref": "GoogleAppsAlertcenterV1beta1AlertFeedback"
+ "$ref": "AlertFeedback"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
@@ -363,7 +363,7 @@
},
"path": "v1beta1/alerts/{alertId}/feedback",
"response": {
- "$ref": "GoogleAppsAlertcenterV1beta1ListAlertFeedbackResponse"
+ "$ref": "ListAlertFeedbackResponse"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
@@ -390,7 +390,7 @@
},
"path": "v1beta1/settings",
"response": {
- "$ref": "GoogleAppsAlertcenterV1beta1Settings"
+ "$ref": "Settings"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
@@ -411,10 +411,10 @@
},
"path": "v1beta1/settings",
"request": {
- "$ref": "GoogleAppsAlertcenterV1beta1Settings"
+ "$ref": "Settings"
},
"response": {
- "$ref": "GoogleAppsAlertcenterV1beta1Settings"
+ "$ref": "Settings"
},
"scopes": [
"https://www.googleapis.com/auth/apps.alerts"
@@ -423,43 +423,33 @@
}
}
},
- "revision": "20210406",
+ "revision": "20210413",
"rootUrl": "https://alertcenter.googleapis.com/",
"schemas": {
- "GoogleAppsAlertcenterTypeAccountWarning": {
+ "AccountWarning": {
"description": "Alerts for user account warning events.",
- "id": "GoogleAppsAlertcenterTypeAccountWarning",
+ "id": "AccountWarning",
"properties": {
"email": {
"description": "Required. The email of the user that this event belongs to.",
"type": "string"
},
"loginDetails": {
- "$ref": "GoogleAppsAlertcenterTypeAccountWarningLoginDetails",
+ "$ref": "LoginDetails",
"description": "Optional. Details of the login action associated with the warning event. This is only available for: * Suspicious login * Suspicious login (less secure app) * Suspicious programmatic login * User suspended (suspicious activity)"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeAccountWarningLoginDetails": {
- "description": "The details of the login action.",
- "id": "GoogleAppsAlertcenterTypeAccountWarningLoginDetails",
- "properties": {
- "ipAddress": {
- "description": "Optional. The human-readable IP address (for example, `11.22.33.44`) that is associated with the warning event.",
- "type": "string"
- },
- "loginTime": {
- "description": "Optional. The successful login time that is associated with the warning event. This isn't present for blocked login attempts.",
- "format": "google-datetime",
- "type": "string"
- }
- },
+ "ActionInfo": {
+ "description": "Metadata related to the action.",
+ "id": "ActionInfo",
+ "properties": {},
"type": "object"
},
- "GoogleAppsAlertcenterTypeActivityRule": {
+ "ActivityRule": {
"description": "Alerts from Google Workspace Security Center rules service configured by an admin.",
- "id": "GoogleAppsAlertcenterTypeActivityRule",
+ "id": "ActivityRule",
"properties": {
"actionNames": {
"description": "List of action names associated with the rule threshold.",
@@ -521,105 +511,194 @@
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeAppMakerSqlSetupNotification": {
- "description": "Alerts from App Maker to notify admins to set up default SQL instance.",
- "id": "GoogleAppsAlertcenterTypeAppMakerSqlSetupNotification",
+ "Alert": {
+ "description": "An alert affecting a customer.",
+ "id": "Alert",
"properties": {
- "requestInfo": {
- "description": "List of applications with requests for default SQL set up.",
- "items": {
- "$ref": "GoogleAppsAlertcenterTypeAppMakerSqlSetupNotificationRequestInfo"
+ "alertId": {
+ "description": "Output only. The unique identifier for the alert.",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "Output only. The time this alert was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "customerId": {
+ "description": "Output only. The unique identifier of the Google account of the customer.",
+ "type": "string"
+ },
+ "data": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
},
- "type": "array"
+ "description": "Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.",
+ "type": "object"
+ },
+ "deleted": {
+ "description": "Output only. `True` if this alert is marked for deletion.",
+ "type": "boolean"
+ },
+ "endTime": {
+ "description": "Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, it indicates an ongoing alert.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "etag": {
+ "description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform alert updates in order to avoid race conditions: An `etag` is returned in the response which contains alerts, and systems are expected to put that etag in the request to update alert to ensure that their change will be applied to the same version of the alert. If no `etag` is provided in the call to update alert, then the existing alert is overwritten blindly.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "AlertMetadata",
+ "description": "Output only. The metadata associated with this alert."
+ },
+ "securityInvestigationToolLink": {
+ "description": "Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.",
+ "type": "string"
+ },
+ "source": {
+ "description": "Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Domain wide takeout * State sponsored attack * Google identity",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Required. The time the event that caused this alert was started or detected.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](/admin-sdk/alertcenter/reference/alert-types).",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. The time this alert was last updated.",
+ "format": "google-datetime",
+ "type": "string"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeAppMakerSqlSetupNotificationRequestInfo": {
- "description": "Requests for one application that needs default SQL setup.",
- "id": "GoogleAppsAlertcenterTypeAppMakerSqlSetupNotificationRequestInfo",
+ "AlertFeedback": {
+ "description": "A customer feedback about an alert.",
+ "id": "AlertFeedback",
"properties": {
- "appDeveloperEmail": {
- "description": "List of app developers who triggered notifications for above application.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "alertId": {
+ "description": "Output only. The alert identifier.",
+ "type": "string"
},
- "appKey": {
- "description": "Required. The application that requires the SQL setup.",
+ "createTime": {
+ "description": "Output only. The time this feedback was created.",
+ "format": "google-datetime",
"type": "string"
},
- "numberOfRequests": {
- "description": "Required. Number of requests sent for this application to set up default SQL instance.",
- "format": "int64",
+ "customerId": {
+ "description": "Output only. The unique identifier of the Google account of the customer.",
+ "type": "string"
+ },
+ "email": {
+ "description": "Output only. The email of the user that provided the feedback.",
+ "type": "string"
+ },
+ "feedbackId": {
+ "description": "Output only. The unique identifier for the feedback.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required. The type of the feedback.",
+ "enum": [
+ "ALERT_FEEDBACK_TYPE_UNSPECIFIED",
+ "NOT_USEFUL",
+ "SOMEWHAT_USEFUL",
+ "VERY_USEFUL"
+ ],
+ "enumDescriptions": [
+ "The feedback type is not specified.",
+ "The alert report is not useful.",
+ "The alert report is somewhat useful.",
+ "The alert report is very useful."
+ ],
"type": "string"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeAttachment": {
- "description": "Attachment with application-specific information about an alert.",
- "id": "GoogleAppsAlertcenterTypeAttachment",
+ "AlertMetadata": {
+ "description": "An alert metadata.",
+ "id": "AlertMetadata",
"properties": {
- "csv": {
- "$ref": "GoogleAppsAlertcenterTypeAttachmentCsv",
- "description": "A CSV file attachment."
+ "alertId": {
+ "description": "Output only. The alert identifier.",
+ "type": "string"
+ },
+ "assignee": {
+ "description": "The email address of the user assigned to the alert.",
+ "type": "string"
+ },
+ "customerId": {
+ "description": "Output only. The unique identifier of the Google account of the customer.",
+ "type": "string"
+ },
+ "etag": {
+ "description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metatdata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly.",
+ "type": "string"
+ },
+ "severity": {
+ "description": "The severity value of the alert. Alert Center will set this field at alert creation time, default's to an empty string when it could not be determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW",
+ "type": "string"
+ },
+ "status": {
+ "description": "The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. The time this metadata was last updated.",
+ "format": "google-datetime",
+ "type": "string"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeAttachmentCsv": {
- "description": "A representation of a CSV file attachment, as a list of column headers and a list of data rows.",
- "id": "GoogleAppsAlertcenterTypeAttachmentCsv",
+ "AppMakerSqlSetupNotification": {
+ "description": "Alerts from App Maker to notify admins to set up default SQL instance.",
+ "id": "AppMakerSqlSetupNotification",
"properties": {
- "dataRows": {
- "description": "The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string.",
- "items": {
- "$ref": "GoogleAppsAlertcenterTypeAttachmentCsvCsvRow"
- },
- "type": "array"
- },
- "headers": {
- "description": "The list of headers for data columns in a CSV file.",
+ "requestInfo": {
+ "description": "List of applications with requests for default SQL set up.",
"items": {
- "type": "string"
+ "$ref": "RequestInfo"
},
"type": "array"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeAttachmentCsvCsvRow": {
- "description": "A representation of a single data row in a CSV file.",
- "id": "GoogleAppsAlertcenterTypeAttachmentCsvCsvRow",
+ "Attachment": {
+ "description": "Attachment with application-specific information about an alert.",
+ "id": "Attachment",
"properties": {
- "entries": {
- "description": "The data entries in a CSV file row, as a string array rather than a single comma-separated string.",
- "items": {
- "type": "string"
- },
- "type": "array"
+ "csv": {
+ "$ref": "Csv",
+ "description": "A CSV file attachment."
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeBadWhitelist": {
+ "BadWhitelist": {
"description": "Alert for setting the domain or IP that malicious email comes from as whitelisted domain or IP in Gmail advanced settings.",
- "id": "GoogleAppsAlertcenterTypeBadWhitelist",
+ "id": "BadWhitelist",
"properties": {
"domainId": {
- "$ref": "GoogleAppsAlertcenterTypeDomainId",
+ "$ref": "DomainId",
"description": "The domain ID."
},
"maliciousEntity": {
- "$ref": "GoogleAppsAlertcenterTypeMaliciousEntity",
+ "$ref": "MaliciousEntity",
"description": "The entity whose actions triggered a Gmail phishing alert."
},
"messages": {
"description": "The list of messages contained by this alert.",
"items": {
- "$ref": "GoogleAppsAlertcenterTypeGmailMessageInfo"
+ "$ref": "GmailMessageInfo"
},
"type": "array"
},
@@ -630,89 +709,225 @@
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeDeviceCompromised": {
- "description": "A mobile device compromised alert. Derived from audit logs.",
- "id": "GoogleAppsAlertcenterTypeDeviceCompromised",
+ "BatchDeleteAlertsRequest": {
+ "description": "A request to perform batch delete on alerts.",
+ "id": "BatchDeleteAlertsRequest",
"properties": {
- "email": {
- "description": "The email of the user this alert was created for.",
- "type": "string"
- },
- "events": {
- "description": "Required. The list of security events.",
+ "alertId": {
+ "description": "Required. list of alert IDs.",
"items": {
- "$ref": "GoogleAppsAlertcenterTypeDeviceCompromisedDeviceCompromisedSecurityDetail"
+ "type": "string"
},
"type": "array"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterTypeDeviceCompromisedDeviceCompromisedSecurityDetail": {
- "description": "Detailed information of a single MDM device compromised event.",
- "id": "GoogleAppsAlertcenterTypeDeviceCompromisedDeviceCompromisedSecurityDetail",
- "properties": {
- "deviceCompromisedState": {
- "description": "The device compromised state. Possible values are \"`Compromised`\" or \"`Not Compromised`\".",
- "type": "string"
- },
- "deviceId": {
- "description": "Required. The device ID.",
- "type": "string"
- },
- "deviceModel": {
- "description": "The model of the device.",
- "type": "string"
- },
- "deviceType": {
- "description": "The type of the device.",
- "type": "string"
- },
- "iosVendorId": {
- "description": "Required for iOS, empty for others.",
- "type": "string"
- },
- "resourceId": {
- "description": "The device resource ID.",
- "type": "string"
},
- "serialNumber": {
- "description": "The serial number of the device.",
+ "customerId": {
+ "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.",
"type": "string"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeDlpRuleViolation": {
- "description": "Alerts that get triggered on violations of Data Loss Prevention (DLP) rules.",
- "id": "GoogleAppsAlertcenterTypeDlpRuleViolation",
+ "BatchDeleteAlertsResponse": {
+ "description": "Response to batch delete operation on alerts.",
+ "id": "BatchDeleteAlertsResponse",
"properties": {
- "ruleViolationInfo": {
- "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfo",
- "description": "Details about the violated DLP rule. Admins can use the predefined detectors provided by Google Cloud DLP https://cloud.google.com/dlp/ when setting up a DLP rule. Matched Cloud DLP detectors in this violation if any will be captured in the MatchInfo.predefined_detector."
+ "failedAlertStatus": {
+ "additionalProperties": {
+ "$ref": "Status"
+ },
+ "description": "The status details for each failed alert_id.",
+ "type": "object"
+ },
+ "successAlertIds": {
+ "description": "The successful list of alert IDs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeDomainId": {
- "description": "Domain ID of Gmail phishing alerts.",
- "id": "GoogleAppsAlertcenterTypeDomainId",
+ "BatchUndeleteAlertsRequest": {
+ "description": "A request to perform batch undelete on alerts.",
+ "id": "BatchUndeleteAlertsRequest",
"properties": {
- "customerPrimaryDomain": {
- "description": "The primary domain for the customer.",
+ "alertId": {
+ "description": "Required. list of alert IDs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "customerId": {
+ "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.",
"type": "string"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeDomainWideTakeoutInitiated": {
- "description": "A takeout operation for the entire domain was initiated by an admin. Derived from audit logs.",
- "id": "GoogleAppsAlertcenterTypeDomainWideTakeoutInitiated",
+ "BatchUndeleteAlertsResponse": {
+ "description": "Response to batch undelete operation on alerts.",
+ "id": "BatchUndeleteAlertsResponse",
"properties": {
- "email": {
- "description": "The email of the admin who initiated the takeout.",
- "type": "string"
- },
+ "failedAlertStatus": {
+ "additionalProperties": {
+ "$ref": "Status"
+ },
+ "description": "The status details for each failed alert_id.",
+ "type": "object"
+ },
+ "successAlertIds": {
+ "description": "The successful list of alert IDs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CloudPubsubTopic": {
+ "description": "A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.",
+ "id": "CloudPubsubTopic",
+ "properties": {
+ "payloadFormat": {
+ "description": "Optional. The format of the payload that would be sent. If not specified the format will be JSON.",
+ "enum": [
+ "PAYLOAD_FORMAT_UNSPECIFIED",
+ "JSON"
+ ],
+ "enumDescriptions": [
+ "Payload format is not specified (will use JSON as default).",
+ "Use JSON."
+ ],
+ "type": "string"
+ },
+ "topicName": {
+ "description": "The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Csv": {
+ "description": "A representation of a CSV file attachment, as a list of column headers and a list of data rows.",
+ "id": "Csv",
+ "properties": {
+ "dataRows": {
+ "description": "The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string.",
+ "items": {
+ "$ref": "CsvRow"
+ },
+ "type": "array"
+ },
+ "headers": {
+ "description": "The list of headers for data columns in a CSV file.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CsvRow": {
+ "description": "A representation of a single data row in a CSV file.",
+ "id": "CsvRow",
+ "properties": {
+ "entries": {
+ "description": "The data entries in a CSV file row, as a string array rather than a single comma-separated string.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DeviceCompromised": {
+ "description": "A mobile device compromised alert. Derived from audit logs.",
+ "id": "DeviceCompromised",
+ "properties": {
+ "email": {
+ "description": "The email of the user this alert was created for.",
+ "type": "string"
+ },
+ "events": {
+ "description": "Required. The list of security events.",
+ "items": {
+ "$ref": "DeviceCompromisedSecurityDetail"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DeviceCompromisedSecurityDetail": {
+ "description": "Detailed information of a single MDM device compromised event.",
+ "id": "DeviceCompromisedSecurityDetail",
+ "properties": {
+ "deviceCompromisedState": {
+ "description": "The device compromised state. Possible values are \"`Compromised`\" or \"`Not Compromised`\".",
+ "type": "string"
+ },
+ "deviceId": {
+ "description": "Required. The device ID.",
+ "type": "string"
+ },
+ "deviceModel": {
+ "description": "The model of the device.",
+ "type": "string"
+ },
+ "deviceType": {
+ "description": "The type of the device.",
+ "type": "string"
+ },
+ "iosVendorId": {
+ "description": "Required for iOS, empty for others.",
+ "type": "string"
+ },
+ "resourceId": {
+ "description": "The device resource ID.",
+ "type": "string"
+ },
+ "serialNumber": {
+ "description": "The serial number of the device.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DlpRuleViolation": {
+ "description": "Alerts that get triggered on violations of Data Loss Prevention (DLP) rules.",
+ "id": "DlpRuleViolation",
+ "properties": {
+ "ruleViolationInfo": {
+ "$ref": "RuleViolationInfo",
+ "description": "Details about the violated DLP rule. Admins can use the predefined detectors provided by Google Cloud DLP https://cloud.google.com/dlp/ when setting up a DLP rule. Matched Cloud DLP detectors in this violation if any will be captured in the MatchInfo.predefined_detector."
+ }
+ },
+ "type": "object"
+ },
+ "DomainId": {
+ "description": "Domain ID of Gmail phishing alerts.",
+ "id": "DomainId",
+ "properties": {
+ "customerPrimaryDomain": {
+ "description": "The primary domain for the customer.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DomainWideTakeoutInitiated": {
+ "description": "A takeout operation for the entire domain was initiated by an admin. Derived from audit logs.",
+ "id": "DomainWideTakeoutInitiated",
+ "properties": {
+ "email": {
+ "description": "The email of the admin who initiated the takeout.",
+ "type": "string"
+ },
"takeoutRequestId": {
"description": "The takeout request ID.",
"type": "string"
@@ -720,9 +935,15 @@
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeGmailMessageInfo": {
+ "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); } The JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "GmailMessageInfo": {
"description": "Details of a message in phishing spike alert.",
- "id": "GoogleAppsAlertcenterTypeGmailMessageInfo",
+ "id": "GmailMessageInfo",
"properties": {
"attachmentsSha256Hash": {
"description": "The `SHA256` hash of email's attachment and all MIME parts.",
@@ -763,9 +984,9 @@
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeGoogleOperations": {
+ "GoogleOperations": {
"description": "An incident reported by Google Operations for a Google Workspace application.",
- "id": "GoogleAppsAlertcenterTypeGoogleOperations",
+ "id": "GoogleOperations",
"properties": {
"affectedUserEmails": {
"description": "The list of emails which correspond to the users directly affected by the incident.",
@@ -775,7 +996,7 @@
"type": "array"
},
"attachmentData": {
- "$ref": "GoogleAppsAlertcenterTypeAttachment",
+ "$ref": "Attachment",
"description": "Optional. Application-specific data for an incident, provided when the Google Workspace application which reported the incident cannot be completely restored to a valid state."
},
"description": {
@@ -793,12 +1014,60 @@
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeMailPhishing": {
+ "ListAlertFeedbackResponse": {
+ "description": "Response message for an alert feedback listing request.",
+ "id": "ListAlertFeedbackResponse",
+ "properties": {
+ "feedback": {
+ "description": "The list of alert feedback. Feedback entries for each alert are ordered by creation time descending.",
+ "items": {
+ "$ref": "AlertFeedback"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListAlertsResponse": {
+ "description": "Response message for an alert listing request.",
+ "id": "ListAlertsResponse",
+ "properties": {
+ "alerts": {
+ "description": "The list of alerts.",
+ "items": {
+ "$ref": "Alert"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "The token for the next page. If not empty, indicates that there may be more alerts that match the listing request; this value can be used in a subsequent ListAlertsRequest to get alerts continuing from last result of the current list call.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LoginDetails": {
+ "description": "The details of the login action.",
+ "id": "LoginDetails",
+ "properties": {
+ "ipAddress": {
+ "description": "Optional. The human-readable IP address (for example, `11.22.33.44`) that is associated with the warning event.",
+ "type": "string"
+ },
+ "loginTime": {
+ "description": "Optional. The successful login time that is associated with the warning event. This isn't present for blocked login attempts.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MailPhishing": {
"description": "Proto for all phishing alerts with common payload. Supported types are any of the following: * User reported phishing * User reported spam spike * Suspicious message reported * Phishing reclassification * Malware reclassification * Gmail potential employee spoofing",
- "id": "GoogleAppsAlertcenterTypeMailPhishing",
+ "id": "MailPhishing",
"properties": {
"domainId": {
- "$ref": "GoogleAppsAlertcenterTypeDomainId",
+ "$ref": "DomainId",
"description": "The domain ID."
},
"isInternal": {
@@ -806,13 +1075,13 @@
"type": "boolean"
},
"maliciousEntity": {
- "$ref": "GoogleAppsAlertcenterTypeMaliciousEntity",
+ "$ref": "MaliciousEntity",
"description": "The entity whose actions triggered a Gmail phishing alert."
},
"messages": {
"description": "The list of messages contained by this alert.",
"items": {
- "$ref": "GoogleAppsAlertcenterTypeGmailMessageInfo"
+ "$ref": "GmailMessageInfo"
},
"type": "array"
},
@@ -833,16 +1102,16 @@
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeMaliciousEntity": {
+ "MaliciousEntity": {
"description": "Entity whose actions triggered a Gmail phishing alert.",
- "id": "GoogleAppsAlertcenterTypeMaliciousEntity",
+ "id": "MaliciousEntity",
"properties": {
"displayName": {
"description": "The header from display name.",
"type": "string"
},
"entity": {
- "$ref": "GoogleAppsAlertcenterTypeUser",
+ "$ref": "User",
"description": "The actor who triggered a gmail phishing alert."
},
"fromHeader": {
@@ -852,12 +1121,38 @@
},
"type": "object"
},
- "GoogleAppsAlertcenterTypePhishingSpike": {
+ "MatchInfo": {
+ "description": "Proto that contains match information from the condition part of the rule.",
+ "id": "MatchInfo",
+ "properties": {
+ "predefinedDetector": {
+ "$ref": "PredefinedDetectorInfo",
+ "description": "For matched detector predefined by Google."
+ },
+ "userDefinedDetector": {
+ "$ref": "UserDefinedDetectorInfo",
+ "description": "For matched detector defined by administrators."
+ }
+ },
+ "type": "object"
+ },
+ "Notification": {
+ "description": "Settings for callback notifications. For more details see [Google Workspace Alert Notification](/admin-sdk/alertcenter/guides/notifications).",
+ "id": "Notification",
+ "properties": {
+ "cloudPubsubTopic": {
+ "$ref": "CloudPubsubTopic",
+ "description": "A Google Cloud Pub/sub topic destination."
+ }
+ },
+ "type": "object"
+ },
+ "PhishingSpike": {
"description": "Alert for a spike in user reported phishing. *Warning*: This type has been deprecated. Use [MailPhishing](/admin-sdk/alertcenter/reference/rest/v1beta1/MailPhishing) instead.",
- "id": "GoogleAppsAlertcenterTypePhishingSpike",
+ "id": "PhishingSpike",
"properties": {
"domainId": {
- "$ref": "GoogleAppsAlertcenterTypeDomainId",
+ "$ref": "DomainId",
"description": "The domain ID."
},
"isInternal": {
@@ -865,61 +1160,125 @@
"type": "boolean"
},
"maliciousEntity": {
- "$ref": "GoogleAppsAlertcenterTypeMaliciousEntity",
+ "$ref": "MaliciousEntity",
"description": "The entity whose actions triggered a Gmail phishing alert."
},
"messages": {
"description": "The list of messages contained by this alert.",
"items": {
- "$ref": "GoogleAppsAlertcenterTypeGmailMessageInfo"
+ "$ref": "GmailMessageInfo"
},
"type": "array"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeRuleViolationInfo": {
- "description": "Common alert information about violated rules that are configured by Google Workspace administrators.",
- "id": "GoogleAppsAlertcenterTypeRuleViolationInfo",
+ "PredefinedDetectorInfo": {
+ "description": "Detector provided by Google.",
+ "id": "PredefinedDetectorInfo",
"properties": {
- "dataSource": {
- "description": "Source of the data.",
- "enum": [
- "DATA_SOURCE_UNSPECIFIED",
- "DRIVE"
- ],
- "enumDescriptions": [
- "Data source is unspecified.",
- "Drive data source."
- ],
+ "detectorName": {
+ "description": "Name that uniquely identifies the detector.",
"type": "string"
- },
- "matchInfo": {
- "description": "List of matches that were found in the resource content.",
- "items": {
- "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfo"
- },
- "type": "array"
- },
- "recipients": {
- "description": "Resource recipients. For Drive, they are grantees that the Drive file was shared with at the time of rule triggering. Valid values include user emails, group emails, domains, or 'anyone' if the file was publicly accessible. If the file was private the recipients list will be empty. For Gmail, they are emails of the users or groups that the Gmail message was sent to.",
+ }
+ },
+ "type": "object"
+ },
+ "RequestInfo": {
+ "description": "Requests for one application that needs default SQL setup.",
+ "id": "RequestInfo",
+ "properties": {
+ "appDeveloperEmail": {
+ "description": "List of app developers who triggered notifications for above application.",
"items": {
"type": "string"
},
"type": "array"
},
- "resourceInfo": {
- "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfoResourceInfo",
- "description": "Details of the resource which violated the rule."
+ "appKey": {
+ "description": "Required. The application that requires the SQL setup.",
+ "type": "string"
},
- "ruleInfo": {
- "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfoRuleInfo",
- "description": "Details of the violated rule."
+ "numberOfRequests": {
+ "description": "Required. Number of requests sent for this application to set up default SQL instance.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ResourceInfo": {
+ "description": "Proto that contains resource information.",
+ "id": "ResourceInfo",
+ "properties": {
+ "documentId": {
+ "description": "Drive file ID.",
+ "type": "string"
},
- "suppressedActionTypes": {
- "description": "Actions suppressed due to other actions with higher priority.",
- "items": {
- "enum": [
+ "resourceTitle": {
+ "description": "Title of the resource, for example email subject, or document title.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RuleInfo": {
+ "description": "Proto that contains rule information.",
+ "id": "RuleInfo",
+ "properties": {
+ "displayName": {
+ "description": "User provided name of the rule.",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "Resource name that uniquely identifies the rule.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RuleViolationInfo": {
+ "description": "Common alert information about violated rules that are configured by Google Workspace administrators.",
+ "id": "RuleViolationInfo",
+ "properties": {
+ "dataSource": {
+ "description": "Source of the data.",
+ "enum": [
+ "DATA_SOURCE_UNSPECIFIED",
+ "DRIVE"
+ ],
+ "enumDescriptions": [
+ "Data source is unspecified.",
+ "Drive data source."
+ ],
+ "type": "string"
+ },
+ "matchInfo": {
+ "description": "List of matches that were found in the resource content.",
+ "items": {
+ "$ref": "MatchInfo"
+ },
+ "type": "array"
+ },
+ "recipients": {
+ "description": "Resource recipients. For Drive, they are grantees that the Drive file was shared with at the time of rule triggering. Valid values include user emails, group emails, domains, or 'anyone' if the file was publicly accessible. If the file was private the recipients list will be empty. For Gmail, they are emails of the users or groups that the Gmail message was sent to.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "resourceInfo": {
+ "$ref": "ResourceInfo",
+ "description": "Details of the resource which violated the rule."
+ },
+ "ruleInfo": {
+ "$ref": "RuleInfo",
+ "description": "Details of the violated rule."
+ },
+ "suppressedActionTypes": {
+ "description": "Actions suppressed due to other actions with higher priority.",
+ "items": {
+ "enum": [
"ACTION_TYPE_UNSPECIFIED",
"DRIVE_BLOCK_EXTERNAL_SHARING",
"DRIVE_WARN_ON_EXTERNAL_SHARING",
@@ -954,7 +1313,7 @@
"triggeredActionInfo": {
"description": "Metadata related to the triggered actions.",
"items": {
- "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfoActionInfo"
+ "$ref": "ActionInfo"
},
"type": "array"
},
@@ -988,97 +1347,61 @@
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeRuleViolationInfoActionInfo": {
- "description": "Metadata related to the action.",
- "id": "GoogleAppsAlertcenterTypeRuleViolationInfoActionInfo",
- "properties": {},
- "type": "object"
- },
- "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfo": {
- "description": "Proto that contains match information from the condition part of the rule.",
- "id": "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfo",
- "properties": {
- "predefinedDetector": {
- "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfoPredefinedDetectorInfo",
- "description": "For matched detector predefined by Google."
- },
- "userDefinedDetector": {
- "$ref": "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfoUserDefinedDetectorInfo",
- "description": "For matched detector defined by administrators."
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfoPredefinedDetectorInfo": {
- "description": "Detector provided by Google.",
- "id": "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfoPredefinedDetectorInfo",
+ "Settings": {
+ "description": "Customer-level settings.",
+ "id": "Settings",
"properties": {
- "detectorName": {
- "description": "Name that uniquely identifies the detector.",
- "type": "string"
+ "notifications": {
+ "description": "The list of notifications.",
+ "items": {
+ "$ref": "Notification"
+ },
+ "type": "array"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfoUserDefinedDetectorInfo": {
- "description": "Detector defined by administrators.",
- "id": "GoogleAppsAlertcenterTypeRuleViolationInfoMatchInfoUserDefinedDetectorInfo",
+ "StateSponsoredAttack": {
+ "description": "A state-sponsored attack alert. Derived from audit logs.",
+ "id": "StateSponsoredAttack",
"properties": {
- "displayName": {
- "description": "Display name of the detector.",
- "type": "string"
- },
- "resourceName": {
- "description": "Resource name that uniquely identifies the detector.",
+ "email": {
+ "description": "The email of the user this incident was created for.",
"type": "string"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeRuleViolationInfoResourceInfo": {
- "description": "Proto that contains resource information.",
- "id": "GoogleAppsAlertcenterTypeRuleViolationInfoResourceInfo",
+ "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": {
- "documentId": {
- "description": "Drive file ID.",
- "type": "string"
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
},
- "resourceTitle": {
- "description": "Title of the resource, for example email subject, or document title.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterTypeRuleViolationInfoRuleInfo": {
- "description": "Proto that contains rule information.",
- "id": "GoogleAppsAlertcenterTypeRuleViolationInfoRuleInfo",
- "properties": {
- "displayName": {
- "description": "User provided name of the rule.",
- "type": "string"
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
},
- "resourceName": {
- "description": "Resource name that uniquely identifies the rule.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterTypeStateSponsoredAttack": {
- "description": "A state-sponsored attack alert. Derived from audit logs.",
- "id": "GoogleAppsAlertcenterTypeStateSponsoredAttack",
- "properties": {
- "email": {
- "description": "The email of the user this incident was created for.",
+ "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"
},
- "GoogleAppsAlertcenterTypeSuspiciousActivity": {
+ "SuspiciousActivity": {
"description": "A mobile suspicious activity alert. Derived from audit logs.",
- "id": "GoogleAppsAlertcenterTypeSuspiciousActivity",
+ "id": "SuspiciousActivity",
"properties": {
"email": {
"description": "The email of the user this alert was created for.",
@@ -1087,16 +1410,16 @@
"events": {
"description": "Required. The list of security events.",
"items": {
- "$ref": "GoogleAppsAlertcenterTypeSuspiciousActivitySuspiciousActivitySecurityDetail"
+ "$ref": "SuspiciousActivitySecurityDetail"
},
"type": "array"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeSuspiciousActivitySuspiciousActivitySecurityDetail": {
+ "SuspiciousActivitySecurityDetail": {
"description": "Detailed information of a single MDM suspicious activity event.",
- "id": "GoogleAppsAlertcenterTypeSuspiciousActivitySuspiciousActivitySecurityDetail",
+ "id": "SuspiciousActivitySecurityDetail",
"properties": {
"deviceId": {
"description": "Required. The device ID.",
@@ -1137,365 +1460,42 @@
},
"type": "object"
},
- "GoogleAppsAlertcenterTypeUser": {
- "description": "A user.",
- "id": "GoogleAppsAlertcenterTypeUser",
- "properties": {
- "displayName": {
- "description": "Display name of the user.",
- "type": "string"
- },
- "emailAddress": {
- "description": "Email address of the user.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterV1beta1Alert": {
- "description": "An alert affecting a customer.",
- "id": "GoogleAppsAlertcenterV1beta1Alert",
- "properties": {
- "alertId": {
- "description": "Output only. The unique identifier for the alert.",
- "type": "string"
- },
- "createTime": {
- "description": "Output only. The time this alert was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "customerId": {
- "description": "Output only. The unique identifier of the Google account of the customer.",
- "type": "string"
- },
- "data": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised.",
- "type": "object"
- },
- "deleted": {
- "description": "Output only. `True` if this alert is marked for deletion.",
- "type": "boolean"
- },
- "endTime": {
- "description": "Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, it indicates an ongoing alert.",
- "format": "google-datetime",
- "type": "string"
- },
- "etag": {
- "description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform alert updates in order to avoid race conditions: An `etag` is returned in the response which contains alerts, and systems are expected to put that etag in the request to update alert to ensure that their change will be applied to the same version of the alert. If no `etag` is provided in the call to update alert, then the existing alert is overwritten blindly.",
- "type": "string"
- },
- "metadata": {
- "$ref": "GoogleAppsAlertcenterV1beta1AlertMetadata",
- "description": "Output only. The metadata associated with this alert."
- },
- "securityInvestigationToolLink": {
- "description": "Output only. An optional [Security Investigation Tool](https://support.google.com/a/answer/7575955) query for this alert.",
- "type": "string"
- },
- "source": {
- "description": "Required. A unique identifier for the system that reported the alert. This is output only after alert is created. Supported sources are any of the following: * Google Operations * Mobile device management * Gmail phishing * Domain wide takeout * State sponsored attack * Google identity",
- "type": "string"
- },
- "startTime": {
- "description": "Required. The time the event that caused this alert was started or detected.",
- "format": "google-datetime",
- "type": "string"
- },
- "type": {
- "description": "Required. The type of the alert. This is output only after alert is created. For a list of available alert types see [Google Workspace Alert types](/admin-sdk/alertcenter/reference/alert-types).",
- "type": "string"
- },
- "updateTime": {
- "description": "Output only. The time this alert was last updated.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterV1beta1AlertFeedback": {
- "description": "A customer feedback about an alert.",
- "id": "GoogleAppsAlertcenterV1beta1AlertFeedback",
- "properties": {
- "alertId": {
- "description": "Output only. The alert identifier.",
- "type": "string"
- },
- "createTime": {
- "description": "Output only. The time this feedback was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "customerId": {
- "description": "Output only. The unique identifier of the Google account of the customer.",
- "type": "string"
- },
- "email": {
- "description": "Output only. The email of the user that provided the feedback.",
- "type": "string"
- },
- "feedbackId": {
- "description": "Output only. The unique identifier for the feedback.",
- "type": "string"
- },
- "type": {
- "description": "Required. The type of the feedback.",
- "enum": [
- "ALERT_FEEDBACK_TYPE_UNSPECIFIED",
- "NOT_USEFUL",
- "SOMEWHAT_USEFUL",
- "VERY_USEFUL"
- ],
- "enumDescriptions": [
- "The feedback type is not specified.",
- "The alert report is not useful.",
- "The alert report is somewhat useful.",
- "The alert report is very useful."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterV1beta1AlertMetadata": {
- "description": "An alert metadata.",
- "id": "GoogleAppsAlertcenterV1beta1AlertMetadata",
- "properties": {
- "alertId": {
- "description": "Output only. The alert identifier.",
- "type": "string"
- },
- "assignee": {
- "description": "The email address of the user assigned to the alert.",
- "type": "string"
- },
- "customerId": {
- "description": "Output only. The unique identifier of the Google account of the customer.",
- "type": "string"
- },
- "etag": {
- "description": "Optional. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert metadata from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform metatdata updates in order to avoid race conditions: An `etag` is returned in the response which contains alert metadata, and systems are expected to put that etag in the request to update alert metadata to ensure that their change will be applied to the same version of the alert metadata. If no `etag` is provided in the call to update alert metadata, then the existing alert metadata is overwritten blindly.",
- "type": "string"
- },
- "severity": {
- "description": "The severity value of the alert. Alert Center will set this field at alert creation time, default's to an empty string when it could not be determined. The supported values for update actions on this field are the following: * HIGH * MEDIUM * LOW",
- "type": "string"
- },
- "status": {
- "description": "The current status of the alert. The supported values are the following: * NOT_STARTED * IN_PROGRESS * CLOSED",
- "type": "string"
- },
- "updateTime": {
- "description": "Output only. The time this metadata was last updated.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterV1beta1BatchDeleteAlertsRequest": {
- "description": "A request to perform batch delete on alerts.",
- "id": "GoogleAppsAlertcenterV1beta1BatchDeleteAlertsRequest",
- "properties": {
- "alertId": {
- "description": "Required. list of alert IDs.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "customerId": {
- "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterV1beta1BatchDeleteAlertsResponse": {
- "description": "Response to batch delete operation on alerts.",
- "id": "GoogleAppsAlertcenterV1beta1BatchDeleteAlertsResponse",
- "properties": {
- "failedAlertStatus": {
- "additionalProperties": {
- "$ref": "GoogleRpcStatus"
- },
- "description": "The status details for each failed alert_id.",
- "type": "object"
- },
- "successAlertIds": {
- "description": "The successful list of alert IDs.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterV1beta1BatchUndeleteAlertsRequest": {
- "description": "A request to perform batch undelete on alerts.",
- "id": "GoogleAppsAlertcenterV1beta1BatchUndeleteAlertsRequest",
+ "UndeleteAlertRequest": {
+ "description": "A request to undelete a specific alert that was marked for deletion.",
+ "id": "UndeleteAlertRequest",
"properties": {
- "alertId": {
- "description": "Required. list of alert IDs.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"customerId": {
- "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alerts are associated with.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterV1beta1BatchUndeleteAlertsResponse": {
- "description": "Response to batch undelete operation on alerts.",
- "id": "GoogleAppsAlertcenterV1beta1BatchUndeleteAlertsResponse",
- "properties": {
- "failedAlertStatus": {
- "additionalProperties": {
- "$ref": "GoogleRpcStatus"
- },
- "description": "The status details for each failed alert_id.",
- "type": "object"
- },
- "successAlertIds": {
- "description": "The successful list of alert IDs.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterV1beta1ListAlertFeedbackResponse": {
- "description": "Response message for an alert feedback listing request.",
- "id": "GoogleAppsAlertcenterV1beta1ListAlertFeedbackResponse",
- "properties": {
- "feedback": {
- "description": "The list of alert feedback. Feedback entries for each alert are ordered by creation time descending.",
- "items": {
- "$ref": "GoogleAppsAlertcenterV1beta1AlertFeedback"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterV1beta1ListAlertsResponse": {
- "description": "Response message for an alert listing request.",
- "id": "GoogleAppsAlertcenterV1beta1ListAlertsResponse",
- "properties": {
- "alerts": {
- "description": "The list of alerts.",
- "items": {
- "$ref": "GoogleAppsAlertcenterV1beta1Alert"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "The token for the next page. If not empty, indicates that there may be more alerts that match the listing request; this value can be used in a subsequent ListAlertsRequest to get alerts continuing from last result of the current list call.",
+ "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.",
"type": "string"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterV1beta1Settings": {
- "description": "Customer-level settings.",
- "id": "GoogleAppsAlertcenterV1beta1Settings",
- "properties": {
- "notifications": {
- "description": "The list of notifications.",
- "items": {
- "$ref": "GoogleAppsAlertcenterV1beta1SettingsNotification"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterV1beta1SettingsNotification": {
- "description": "Settings for callback notifications. For more details see [Google Workspace Alert Notification](/admin-sdk/alertcenter/guides/notifications).",
- "id": "GoogleAppsAlertcenterV1beta1SettingsNotification",
- "properties": {
- "cloudPubsubTopic": {
- "$ref": "GoogleAppsAlertcenterV1beta1SettingsNotificationCloudPubsubTopic",
- "description": "A Google Cloud Pub/sub topic destination."
- }
- },
- "type": "object"
- },
- "GoogleAppsAlertcenterV1beta1SettingsNotificationCloudPubsubTopic": {
- "description": "A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.",
- "id": "GoogleAppsAlertcenterV1beta1SettingsNotificationCloudPubsubTopic",
+ "User": {
+ "description": "A user.",
+ "id": "User",
"properties": {
- "payloadFormat": {
- "description": "Optional. The format of the payload that would be sent. If not specified the format will be JSON.",
- "enum": [
- "PAYLOAD_FORMAT_UNSPECIFIED",
- "JSON"
- ],
- "enumDescriptions": [
- "Payload format is not specified (will use JSON as default).",
- "Use JSON."
- ],
+ "displayName": {
+ "description": "Display name of the user.",
"type": "string"
},
- "topicName": {
- "description": "The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).",
+ "emailAddress": {
+ "description": "Email address of the user.",
"type": "string"
}
},
"type": "object"
},
- "GoogleAppsAlertcenterV1beta1UndeleteAlertRequest": {
- "description": "A request to undelete a specific alert that was marked for deletion.",
- "id": "GoogleAppsAlertcenterV1beta1UndeleteAlertRequest",
+ "UserDefinedDetectorInfo": {
+ "description": "Detector defined by administrators.",
+ "id": "UserDefinedDetectorInfo",
"properties": {
- "customerId": {
- "description": "Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.",
+ "displayName": {
+ "description": "Display name of the detector.",
"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); } The JSON representation for `Empty` is empty JSON object `{}`.",
- "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.",
+ "resourceName": {
+ "description": "Resource name that uniquely identifies the detector.",
"type": "string"
}
},
diff --git a/googleapiclient/discovery_cache/documents/composer.v1.json b/googleapiclient/discovery_cache/documents/composer.v1.json
index 3bc90b13273..d5f05d18b90 100644
--- a/googleapiclient/discovery_cache/documents/composer.v1.json
+++ b/googleapiclient/discovery_cache/documents/composer.v1.json
@@ -406,7 +406,7 @@
}
}
},
- "revision": "20210413",
+ "revision": "20210421",
"rootUrl": "https://composer.googleapis.com/",
"schemas": {
"AllowedIpRange": {
diff --git a/googleapiclient/discovery_cache/documents/composer.v1beta1.json b/googleapiclient/discovery_cache/documents/composer.v1beta1.json
index b05a1923540..6e0a50039d7 100644
--- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json
@@ -434,7 +434,7 @@
}
}
},
- "revision": "20210413",
+ "revision": "20210421",
"rootUrl": "https://composer.googleapis.com/",
"schemas": {
"AllowedIpRange": {
@@ -492,7 +492,7 @@
"type": "object"
},
"EncryptionConfig": {
- "description": "The encryption options for the Composer environment and its dependencies.",
+ "description": "The encryption options for the Cloud Composer environment and its dependencies.",
"id": "EncryptionConfig",
"properties": {
"kmsKeyName": {
@@ -581,7 +581,7 @@
},
"encryptionConfig": {
"$ref": "EncryptionConfig",
- "description": "Optional. The encryption options for the Composer environment and its dependencies. Cannot be updated."
+ "description": "Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated."
},
"gkeCluster": {
"description": "Output only. The Kubernetes Engine cluster used to run this environment.",
@@ -794,7 +794,7 @@
"type": "array"
},
"serviceAccount": {
- "description": "Optional. The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the \"default\" Compute Engine service account is used. Cannot be updated.",
+ "description": "Optional. The Google Cloud Platform Service Account to be used by the workloads. If a service account is not specified, the \"default\" Compute Engine service account is used. Cannot be updated .",
"type": "string"
},
"subnetwork": {
@@ -936,7 +936,7 @@
"type": "string"
},
"enablePrivateEnvironment": {
- "description": "Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true.",
+ "description": "Optional. If `true`, a Private IP Cloud Composer environment is created. If this field is set to true, `IPAllocationPolicy.use_ip_aliases` must be set to true .",
"type": "boolean"
},
"privateClusterConfig": {
diff --git a/googleapiclient/discovery_cache/documents/datastore.v1.json b/googleapiclient/discovery_cache/documents/datastore.v1.json
index 9d0375d31e2..1d82d5f3cc1 100644
--- a/googleapiclient/discovery_cache/documents/datastore.v1.json
+++ b/googleapiclient/discovery_cache/documents/datastore.v1.json
@@ -625,7 +625,7 @@
}
}
},
- "revision": "20210326",
+ "revision": "20210419",
"rootUrl": "https://datastore.googleapis.com/",
"schemas": {
"AllocateIdsRequest": {
diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json
index 5177209699d..53e1897e5b7 100644
--- a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json
@@ -167,7 +167,7 @@
}
}
},
- "revision": "20210326",
+ "revision": "20210419",
"rootUrl": "https://datastore.googleapis.com/",
"schemas": {
"GoogleDatastoreAdminV1CommonMetadata": {
diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json
index a019ec57047..428e65ae744 100644
--- a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json
+++ b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json
@@ -307,7 +307,7 @@
}
}
},
- "revision": "20210326",
+ "revision": "20210419",
"rootUrl": "https://datastore.googleapis.com/",
"schemas": {
"AllocateIdsRequest": {
diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json
index e6d239be900..1d16eb69572 100644
--- a/googleapiclient/discovery_cache/documents/firestore.v1.json
+++ b/googleapiclient/discovery_cache/documents/firestore.v1.json
@@ -1135,7 +1135,7 @@
"type": "string"
},
"pageSize": {
- "description": "The maximum number of results to return. If not set, the service will select a default.",
+ "description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -1160,7 +1160,7 @@
}
}
},
- "revision": "20210326",
+ "revision": "20210419",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"ArrayValue": {
diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json
index 1fe91df6df0..bddff80941a 100644
--- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json
@@ -849,7 +849,7 @@
}
}
},
- "revision": "20210326",
+ "revision": "20210419",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"ArrayValue": {
diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json
index 8b3c228efb1..a04d3e2289e 100644
--- a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json
+++ b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json
@@ -415,7 +415,7 @@
}
}
},
- "revision": "20210326",
+ "revision": "20210419",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"Empty": {
diff --git a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json
index fcc10f43f95..afaa202bb36 100644
--- a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json
@@ -2484,7 +2484,7 @@
}
}
},
- "revision": "20210422",
+ "revision": "20210424",
"rootUrl": "https://prod-tt-sasportal.googleapis.com/",
"schemas": {
"SasPortalAssignment": {
diff --git a/googleapiclient/discovery_cache/documents/searchconsole.v1.json b/googleapiclient/discovery_cache/documents/searchconsole.v1.json
index 87455615d76..b41b805678e 100644
--- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json
+++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json
@@ -373,7 +373,7 @@
}
}
},
- "revision": "20210420",
+ "revision": "20210424",
"rootUrl": "https://searchconsole.googleapis.com/",
"schemas": {
"ApiDataRow": {